aws-sdk-codecatalyst 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-codecatalyst/client.rb +1668 -0
- data/lib/aws-sdk-codecatalyst/client_api.rb +994 -0
- data/lib/aws-sdk-codecatalyst/customizations.rb +0 -0
- data/lib/aws-sdk-codecatalyst/endpoint_parameters.rb +54 -0
- data/lib/aws-sdk-codecatalyst/endpoint_provider.rb +85 -0
- data/lib/aws-sdk-codecatalyst/endpoints.rb +327 -0
- data/lib/aws-sdk-codecatalyst/errors.rb +138 -0
- data/lib/aws-sdk-codecatalyst/plugins/endpoints.rb +116 -0
- data/lib/aws-sdk-codecatalyst/resource.rb +26 -0
- data/lib/aws-sdk-codecatalyst/types.rb +2040 -0
- data/lib/aws-sdk-codecatalyst/waiters.rb +15 -0
- data/lib/aws-sdk-codecatalyst.rb +57 -0
- metadata +81 -0
@@ -0,0 +1,1668 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
|
+
|
36
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:codecatalyst)
|
37
|
+
|
38
|
+
module Aws::CodeCatalyst
|
39
|
+
# An API client for CodeCatalyst. To construct a client, you need to configure a `:region` and `:credentials`.
|
40
|
+
#
|
41
|
+
# client = Aws::CodeCatalyst::Client.new(
|
42
|
+
# region: region_name,
|
43
|
+
# credentials: credentials,
|
44
|
+
# # ...
|
45
|
+
# )
|
46
|
+
#
|
47
|
+
# For details on configuring region and credentials see
|
48
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
49
|
+
#
|
50
|
+
# See {#initialize} for a full list of supported configuration options.
|
51
|
+
class Client < Seahorse::Client::Base
|
52
|
+
|
53
|
+
include Aws::ClientStubs
|
54
|
+
|
55
|
+
@identifier = :codecatalyst
|
56
|
+
|
57
|
+
set_api(ClientApi::API)
|
58
|
+
|
59
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
60
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
61
|
+
add_plugin(Aws::Plugins::Logging)
|
62
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
63
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
64
|
+
add_plugin(Aws::Plugins::UserAgent)
|
65
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
66
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
67
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
68
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
69
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
70
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
71
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
72
|
+
add_plugin(Aws::Plugins::StubResponses)
|
73
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
74
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
75
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
76
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
77
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
78
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
81
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::CodeCatalyst::Plugins::Endpoints)
|
85
|
+
|
86
|
+
# @overload initialize(options)
|
87
|
+
# @param [Hash] options
|
88
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
89
|
+
# Your AWS credentials. This can be an instance of any one of the
|
90
|
+
# following classes:
|
91
|
+
#
|
92
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
93
|
+
# credentials.
|
94
|
+
#
|
95
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
96
|
+
# shared file, such as `~/.aws/config`.
|
97
|
+
#
|
98
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
99
|
+
#
|
100
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
101
|
+
# assume a role after providing credentials via the web.
|
102
|
+
#
|
103
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
104
|
+
# access token generated from `aws login`.
|
105
|
+
#
|
106
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
107
|
+
# process that outputs to stdout.
|
108
|
+
#
|
109
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
110
|
+
# from an EC2 IMDS on an EC2 instance.
|
111
|
+
#
|
112
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
113
|
+
# instances running in ECS.
|
114
|
+
#
|
115
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
116
|
+
# from the Cognito Identity service.
|
117
|
+
#
|
118
|
+
# When `:credentials` are not configured directly, the following
|
119
|
+
# locations will be searched for credentials:
|
120
|
+
#
|
121
|
+
# * `Aws.config[:credentials]`
|
122
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
123
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
124
|
+
# * `~/.aws/credentials`
|
125
|
+
# * `~/.aws/config`
|
126
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
127
|
+
# are very aggressive. Construct and pass an instance of
|
128
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
129
|
+
# enable retries and extended timeouts. Instance profile credential
|
130
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
131
|
+
# to true.
|
132
|
+
#
|
133
|
+
# @option options [required, String] :region
|
134
|
+
# The AWS region to connect to. The configured `:region` is
|
135
|
+
# used to determine the service `:endpoint`. When not passed,
|
136
|
+
# a default `:region` is searched for in the following locations:
|
137
|
+
#
|
138
|
+
# * `Aws.config[:region]`
|
139
|
+
# * `ENV['AWS_REGION']`
|
140
|
+
# * `ENV['AMAZON_REGION']`
|
141
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
142
|
+
# * `~/.aws/credentials`
|
143
|
+
# * `~/.aws/config`
|
144
|
+
#
|
145
|
+
# @option options [String] :access_key_id
|
146
|
+
#
|
147
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
148
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
149
|
+
# the background every 60 secs (default). Defaults to `false`.
|
150
|
+
#
|
151
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
152
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
153
|
+
# until there is sufficent client side capacity to retry the request.
|
154
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
155
|
+
# not retry instead of sleeping.
|
156
|
+
#
|
157
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
158
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
159
|
+
# this client.
|
160
|
+
#
|
161
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
162
|
+
# Allows you to provide an identifier for this client which will be attached to
|
163
|
+
# all generated client side metrics. Defaults to an empty string.
|
164
|
+
#
|
165
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
166
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
167
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
168
|
+
#
|
169
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
170
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
171
|
+
# agent is running on, where client metrics will be published via UDP.
|
172
|
+
#
|
173
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
174
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
175
|
+
# will use the Client Side Monitoring Agent Publisher.
|
176
|
+
#
|
177
|
+
# @option options [Boolean] :convert_params (true)
|
178
|
+
# When `true`, an attempt is made to coerce request parameters into
|
179
|
+
# the required types.
|
180
|
+
#
|
181
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
182
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
183
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
184
|
+
#
|
185
|
+
# @option options [String] :defaults_mode ("legacy")
|
186
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
187
|
+
# accepted modes and the configuration defaults that are included.
|
188
|
+
#
|
189
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
190
|
+
# Set to true to disable SDK automatically adding host prefix
|
191
|
+
# to default service endpoint when available.
|
192
|
+
#
|
193
|
+
# @option options [String] :endpoint
|
194
|
+
# The client endpoint is normally constructed from the `:region`
|
195
|
+
# option. You should only configure an `:endpoint` when connecting
|
196
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
197
|
+
#
|
198
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
199
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
200
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
201
|
+
#
|
202
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
203
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
204
|
+
#
|
205
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
206
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
207
|
+
# Use this option to config the time interval in seconds for making
|
208
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
209
|
+
#
|
210
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
211
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
212
|
+
#
|
213
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
214
|
+
# The log formatter.
|
215
|
+
#
|
216
|
+
# @option options [Symbol] :log_level (:info)
|
217
|
+
# The log level to send messages to the `:logger` at.
|
218
|
+
#
|
219
|
+
# @option options [Logger] :logger
|
220
|
+
# The Logger instance to send log messages to. If this option
|
221
|
+
# is not set, logging will be disabled.
|
222
|
+
#
|
223
|
+
# @option options [Integer] :max_attempts (3)
|
224
|
+
# An integer representing the maximum number attempts that will be made for
|
225
|
+
# a single request, including the initial attempt. For example,
|
226
|
+
# setting this value to 5 will result in a request being retried up to
|
227
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
228
|
+
#
|
229
|
+
# @option options [String] :profile ("default")
|
230
|
+
# Used when loading credentials from the shared credentials file
|
231
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
232
|
+
#
|
233
|
+
# @option options [Proc] :retry_backoff
|
234
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
235
|
+
# This option is only used in the `legacy` retry mode.
|
236
|
+
#
|
237
|
+
# @option options [Float] :retry_base_delay (0.3)
|
238
|
+
# The base delay in seconds used by the default backoff function. This option
|
239
|
+
# is only used in the `legacy` retry mode.
|
240
|
+
#
|
241
|
+
# @option options [Symbol] :retry_jitter (:none)
|
242
|
+
# A delay randomiser function used by the default backoff function.
|
243
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
244
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
245
|
+
# in the `legacy` retry mode.
|
246
|
+
#
|
247
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
248
|
+
#
|
249
|
+
# @option options [Integer] :retry_limit (3)
|
250
|
+
# The maximum number of times to retry failed requests. Only
|
251
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
252
|
+
# are retried. Generally, these are throttling errors, data
|
253
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
254
|
+
# endpoint discovery, and errors from expired credentials.
|
255
|
+
# This option is only used in the `legacy` retry mode.
|
256
|
+
#
|
257
|
+
# @option options [Integer] :retry_max_delay (0)
|
258
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
259
|
+
# used by the default backoff function. This option is only used in the
|
260
|
+
# `legacy` retry mode.
|
261
|
+
#
|
262
|
+
# @option options [String] :retry_mode ("legacy")
|
263
|
+
# Specifies which retry algorithm to use. Values are:
|
264
|
+
#
|
265
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
266
|
+
# no retry mode is provided.
|
267
|
+
#
|
268
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
269
|
+
# This includes support for retry quotas, which limit the number of
|
270
|
+
# unsuccessful retries a client can make.
|
271
|
+
#
|
272
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
273
|
+
# functionality of `standard` mode along with automatic client side
|
274
|
+
# throttling. This is a provisional mode that may change behavior
|
275
|
+
# in the future.
|
276
|
+
#
|
277
|
+
#
|
278
|
+
# @option options [String] :secret_access_key
|
279
|
+
#
|
280
|
+
# @option options [String] :session_token
|
281
|
+
#
|
282
|
+
# @option options [Boolean] :stub_responses (false)
|
283
|
+
# Causes the client to return stubbed responses. By default
|
284
|
+
# fake responses are generated and returned. You can specify
|
285
|
+
# the response data to return or errors to raise by calling
|
286
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
287
|
+
#
|
288
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
289
|
+
# requests are made, and retries are disabled.
|
290
|
+
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
304
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
305
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
306
|
+
# will be used if available.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :use_fips_endpoint
|
309
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
310
|
+
# When a `fips` region is used, the region is normalized and this config
|
311
|
+
# is set to `true`.
|
312
|
+
#
|
313
|
+
# @option options [Boolean] :validate_params (true)
|
314
|
+
# When `true`, request parameters are validated before
|
315
|
+
# sending the request.
|
316
|
+
#
|
317
|
+
# @option options [Aws::CodeCatalyst::EndpointProvider] :endpoint_provider
|
318
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CodeCatalyst::EndpointParameters`
|
319
|
+
#
|
320
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
321
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
322
|
+
#
|
323
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
324
|
+
# seconds to wait when opening a HTTP session before raising a
|
325
|
+
# `Timeout::Error`.
|
326
|
+
#
|
327
|
+
# @option options [Float] :http_read_timeout (60) The default
|
328
|
+
# number of seconds to wait for response data. This value can
|
329
|
+
# safely be set per-request on the session.
|
330
|
+
#
|
331
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
332
|
+
# seconds a connection is allowed to sit idle before it is
|
333
|
+
# considered stale. Stale connections are closed and removed
|
334
|
+
# from the pool before making a request.
|
335
|
+
#
|
336
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
337
|
+
# seconds to wait for a 100-continue response before sending the
|
338
|
+
# request body. This option has no effect unless the request has
|
339
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
340
|
+
# disables this behaviour. This value can safely be set per
|
341
|
+
# request on the session.
|
342
|
+
#
|
343
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
344
|
+
# in seconds.
|
345
|
+
#
|
346
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
347
|
+
# HTTP debug output will be sent to the `:logger`.
|
348
|
+
#
|
349
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
350
|
+
# SSL peer certificates are verified when establishing a
|
351
|
+
# connection.
|
352
|
+
#
|
353
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
354
|
+
# certificate authority bundle file that should be used when
|
355
|
+
# verifying peer certificates. If you do not pass
|
356
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
357
|
+
# will be used if available.
|
358
|
+
#
|
359
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
360
|
+
# directory that contains the unbundled SSL certificate
|
361
|
+
# authority files for verifying peer certificates. If you do
|
362
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
363
|
+
# system default will be used if available.
|
364
|
+
#
|
365
|
+
def initialize(*args)
|
366
|
+
super
|
367
|
+
end
|
368
|
+
|
369
|
+
# @!group API Operations
|
370
|
+
|
371
|
+
# Creates a personal access token (PAT) for the current user. A personal
|
372
|
+
# access token (PAT) is similar to a password. It is associated with
|
373
|
+
# your user account. You use PATs to access Amazon CodeCatalyst
|
374
|
+
# resources such as source repositories from third-party applications
|
375
|
+
# like Git and integrated development environments (IDEs). For more
|
376
|
+
# information, see [Managing personal access tokens in Amazon
|
377
|
+
# CodeCatalyst][1].
|
378
|
+
#
|
379
|
+
#
|
380
|
+
#
|
381
|
+
# [1]: https://docs.aws.amazon.com/codecatalyst/latest/userguide/ipa-tokens-keys.html
|
382
|
+
#
|
383
|
+
# @option params [required, String] :name
|
384
|
+
# The friendly name of the personal access token.
|
385
|
+
#
|
386
|
+
# @option params [Time,DateTime,Date,Integer,String] :expires_time
|
387
|
+
# The date and time the personal access token expires, in coordinated
|
388
|
+
# universal time (UTC) timestamp format as specified in [RFC 3339][1].
|
389
|
+
#
|
390
|
+
#
|
391
|
+
#
|
392
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6
|
393
|
+
#
|
394
|
+
# @return [Types::CreateAccessTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
395
|
+
#
|
396
|
+
# * {Types::CreateAccessTokenResponse#secret #secret} => String
|
397
|
+
# * {Types::CreateAccessTokenResponse#name #name} => String
|
398
|
+
# * {Types::CreateAccessTokenResponse#expires_time #expires_time} => Time
|
399
|
+
#
|
400
|
+
# @example Request syntax with placeholder values
|
401
|
+
#
|
402
|
+
# resp = client.create_access_token({
|
403
|
+
# name: "AccessTokenName", # required
|
404
|
+
# expires_time: Time.now,
|
405
|
+
# })
|
406
|
+
#
|
407
|
+
# @example Response structure
|
408
|
+
#
|
409
|
+
# resp.secret #=> String
|
410
|
+
# resp.name #=> String
|
411
|
+
# resp.expires_time #=> Time
|
412
|
+
#
|
413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/CreateAccessToken AWS API Documentation
|
414
|
+
#
|
415
|
+
# @overload create_access_token(params = {})
|
416
|
+
# @param [Hash] params ({})
|
417
|
+
def create_access_token(params = {}, options = {})
|
418
|
+
req = build_request(:create_access_token, params)
|
419
|
+
req.send_request(options)
|
420
|
+
end
|
421
|
+
|
422
|
+
# Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based
|
423
|
+
# development Dev Environment that you can use to quickly work on the
|
424
|
+
# code stored in the source repositories of your project. By default, a
|
425
|
+
# Dev Environment is configured to have a 2 core processor, 4GB of RAM,
|
426
|
+
# and 16GB of persistent storage.
|
427
|
+
#
|
428
|
+
# @option params [required, String] :space_name
|
429
|
+
# The name of the space.
|
430
|
+
#
|
431
|
+
# @option params [required, String] :project_name
|
432
|
+
# The name of the project in the space.
|
433
|
+
#
|
434
|
+
# @option params [Array<Types::RepositoryInput>] :repositories
|
435
|
+
# The source repository that contains the branch to clone into the Dev
|
436
|
+
# Environment.
|
437
|
+
#
|
438
|
+
# @option params [String] :client_token
|
439
|
+
# A user-specified idempotency token. Idempotency ensures that an API
|
440
|
+
# request completes only once. With an idempotent request, if the
|
441
|
+
# original request completes successfully, the subsequent retries return
|
442
|
+
# the result from the original successful request and have no additional
|
443
|
+
# effect.
|
444
|
+
#
|
445
|
+
# @option params [String] :alias
|
446
|
+
# The user-defined alias for a Dev Environment.
|
447
|
+
#
|
448
|
+
# @option params [Array<Types::IdeConfiguration>] :ides
|
449
|
+
# Information about the integrated development environment (IDE)
|
450
|
+
# configured for a Dev Environment.
|
451
|
+
#
|
452
|
+
# <note markdown="1"> An IDE is required to create a Dev Environment. For Dev Environment
|
453
|
+
# creation, this field contains configuration information and must be
|
454
|
+
# provided.
|
455
|
+
#
|
456
|
+
# </note>
|
457
|
+
#
|
458
|
+
# @option params [required, String] :instance_type
|
459
|
+
# The Amazon EC2 instace type to use for the Dev Environment.
|
460
|
+
#
|
461
|
+
# @option params [Integer] :inactivity_timeout_minutes
|
462
|
+
# The amount of time the Dev Environment will run without any activity
|
463
|
+
# detected before stopping, in minutes. Only whole integers are allowed.
|
464
|
+
# Dev Environments consume compute minutes when running.
|
465
|
+
#
|
466
|
+
# @option params [required, Types::PersistentStorageConfiguration] :persistent_storage
|
467
|
+
# Information about the amount of storage allocated to the Dev
|
468
|
+
# Environment. By default, a Dev Environment is configured to have 16GB
|
469
|
+
# of persistent storage.
|
470
|
+
#
|
471
|
+
# <note markdown="1"> Valid values for persistent storage are based on memory sizes in 16GB
|
472
|
+
# increments. Valid values are 16, 32, and 64.
|
473
|
+
#
|
474
|
+
# </note>
|
475
|
+
#
|
476
|
+
# @return [Types::CreateDevEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
477
|
+
#
|
478
|
+
# * {Types::CreateDevEnvironmentResponse#space_name #space_name} => String
|
479
|
+
# * {Types::CreateDevEnvironmentResponse#project_name #project_name} => String
|
480
|
+
# * {Types::CreateDevEnvironmentResponse#id #id} => String
|
481
|
+
#
|
482
|
+
# @example Request syntax with placeholder values
|
483
|
+
#
|
484
|
+
# resp = client.create_dev_environment({
|
485
|
+
# space_name: "NameString", # required
|
486
|
+
# project_name: "NameString", # required
|
487
|
+
# repositories: [
|
488
|
+
# {
|
489
|
+
# repository_name: "SourceRepositoryNameString", # required
|
490
|
+
# branch_name: "SourceRepositoryBranchString",
|
491
|
+
# },
|
492
|
+
# ],
|
493
|
+
# client_token: "ClientToken",
|
494
|
+
# alias: "CreateDevEnvironmentRequestAliasString",
|
495
|
+
# ides: [
|
496
|
+
# {
|
497
|
+
# runtime: "IdeConfigurationRuntimeString",
|
498
|
+
# name: "IdeConfigurationNameString",
|
499
|
+
# },
|
500
|
+
# ],
|
501
|
+
# instance_type: "dev.standard1.small", # required, accepts dev.standard1.small, dev.standard1.medium, dev.standard1.large, dev.standard1.xlarge
|
502
|
+
# inactivity_timeout_minutes: 1,
|
503
|
+
# persistent_storage: { # required
|
504
|
+
# size_in_gi_b: 1, # required
|
505
|
+
# },
|
506
|
+
# })
|
507
|
+
#
|
508
|
+
# @example Response structure
|
509
|
+
#
|
510
|
+
# resp.space_name #=> String
|
511
|
+
# resp.project_name #=> String
|
512
|
+
# resp.id #=> String
|
513
|
+
#
|
514
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/CreateDevEnvironment AWS API Documentation
|
515
|
+
#
|
516
|
+
# @overload create_dev_environment(params = {})
|
517
|
+
# @param [Hash] params ({})
|
518
|
+
def create_dev_environment(params = {}, options = {})
|
519
|
+
req = build_request(:create_dev_environment, params)
|
520
|
+
req.send_request(options)
|
521
|
+
end
|
522
|
+
|
523
|
+
# Creates a project in a specified space.
|
524
|
+
#
|
525
|
+
# @option params [required, String] :space_name
|
526
|
+
# The name of the space.
|
527
|
+
#
|
528
|
+
# @option params [required, String] :display_name
|
529
|
+
# The friendly name of the project that will be displayed to users.
|
530
|
+
#
|
531
|
+
# @option params [String] :description
|
532
|
+
# The description of the project. This description will be displayed to
|
533
|
+
# all users of the project. We recommend providing a brief description
|
534
|
+
# of the project and its intended purpose.
|
535
|
+
#
|
536
|
+
# @return [Types::CreateProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
537
|
+
#
|
538
|
+
# * {Types::CreateProjectResponse#space_name #space_name} => String
|
539
|
+
# * {Types::CreateProjectResponse#name #name} => String
|
540
|
+
# * {Types::CreateProjectResponse#display_name #display_name} => String
|
541
|
+
# * {Types::CreateProjectResponse#description #description} => String
|
542
|
+
#
|
543
|
+
# @example Request syntax with placeholder values
|
544
|
+
#
|
545
|
+
# resp = client.create_project({
|
546
|
+
# space_name: "NameString", # required
|
547
|
+
# display_name: "ProjectDisplayName", # required
|
548
|
+
# description: "ProjectDescription",
|
549
|
+
# })
|
550
|
+
#
|
551
|
+
# @example Response structure
|
552
|
+
#
|
553
|
+
# resp.space_name #=> String
|
554
|
+
# resp.name #=> String
|
555
|
+
# resp.display_name #=> String
|
556
|
+
# resp.description #=> String
|
557
|
+
#
|
558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/CreateProject AWS API Documentation
|
559
|
+
#
|
560
|
+
# @overload create_project(params = {})
|
561
|
+
# @param [Hash] params ({})
|
562
|
+
def create_project(params = {}, options = {})
|
563
|
+
req = build_request(:create_project, params)
|
564
|
+
req.send_request(options)
|
565
|
+
end
|
566
|
+
|
567
|
+
# Creates a branch in a specified source repository in Amazon
|
568
|
+
# CodeCatalyst.
|
569
|
+
#
|
570
|
+
# <note markdown="1"> This API only creates a branch in a source repository hosted in Amazon
|
571
|
+
# CodeCatalyst. You cannot use this API to create a branch in a linked
|
572
|
+
# repository.
|
573
|
+
#
|
574
|
+
# </note>
|
575
|
+
#
|
576
|
+
# @option params [required, String] :space_name
|
577
|
+
# The name of the space.
|
578
|
+
#
|
579
|
+
# @option params [required, String] :project_name
|
580
|
+
# The name of the project in the space.
|
581
|
+
#
|
582
|
+
# @option params [required, String] :source_repository_name
|
583
|
+
# The name of the repository where you want to create a branch.
|
584
|
+
#
|
585
|
+
# @option params [required, String] :name
|
586
|
+
# The name for the branch you're creating.
|
587
|
+
#
|
588
|
+
# @option params [String] :head_commit_id
|
589
|
+
# The commit ID in an existing branch from which you want to create the
|
590
|
+
# new branch.
|
591
|
+
#
|
592
|
+
# @return [Types::CreateSourceRepositoryBranchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
593
|
+
#
|
594
|
+
# * {Types::CreateSourceRepositoryBranchResponse#ref #ref} => String
|
595
|
+
# * {Types::CreateSourceRepositoryBranchResponse#name #name} => String
|
596
|
+
# * {Types::CreateSourceRepositoryBranchResponse#last_updated_time #last_updated_time} => Time
|
597
|
+
# * {Types::CreateSourceRepositoryBranchResponse#head_commit_id #head_commit_id} => String
|
598
|
+
#
|
599
|
+
# @example Request syntax with placeholder values
|
600
|
+
#
|
601
|
+
# resp = client.create_source_repository_branch({
|
602
|
+
# space_name: "NameString", # required
|
603
|
+
# project_name: "NameString", # required
|
604
|
+
# source_repository_name: "SourceRepositoryNameString", # required
|
605
|
+
# name: "SourceRepositoryBranchString", # required
|
606
|
+
# head_commit_id: "String",
|
607
|
+
# })
|
608
|
+
#
|
609
|
+
# @example Response structure
|
610
|
+
#
|
611
|
+
# resp.ref #=> String
|
612
|
+
# resp.name #=> String
|
613
|
+
# resp.last_updated_time #=> Time
|
614
|
+
# resp.head_commit_id #=> String
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/CreateSourceRepositoryBranch AWS API Documentation
|
617
|
+
#
|
618
|
+
# @overload create_source_repository_branch(params = {})
|
619
|
+
# @param [Hash] params ({})
|
620
|
+
def create_source_repository_branch(params = {}, options = {})
|
621
|
+
req = build_request(:create_source_repository_branch, params)
|
622
|
+
req.send_request(options)
|
623
|
+
end
|
624
|
+
|
625
|
+
# Deletes a specified personal access token (PAT). A personal access
|
626
|
+
# token can only be deleted by the user who created it.
|
627
|
+
#
|
628
|
+
# @option params [required, String] :id
|
629
|
+
# The ID of the personal access token to delete. You can find the IDs of
|
630
|
+
# all PATs associated with your user account by calling
|
631
|
+
# ListAccessTokens.
|
632
|
+
#
|
633
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
634
|
+
#
|
635
|
+
# @example Request syntax with placeholder values
|
636
|
+
#
|
637
|
+
# resp = client.delete_access_token({
|
638
|
+
# id: "AccessTokenId", # required
|
639
|
+
# })
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/DeleteAccessToken AWS API Documentation
|
642
|
+
#
|
643
|
+
# @overload delete_access_token(params = {})
|
644
|
+
# @param [Hash] params ({})
|
645
|
+
def delete_access_token(params = {}, options = {})
|
646
|
+
req = build_request(:delete_access_token, params)
|
647
|
+
req.send_request(options)
|
648
|
+
end
|
649
|
+
|
650
|
+
# Deletes a Dev Environment.
|
651
|
+
#
|
652
|
+
# @option params [required, String] :space_name
|
653
|
+
# The name of the space.
|
654
|
+
#
|
655
|
+
# @option params [required, String] :project_name
|
656
|
+
# The name of the project in the space.
|
657
|
+
#
|
658
|
+
# @option params [required, String] :id
|
659
|
+
# The system-generated unique ID of the Dev Environment you want to
|
660
|
+
# delete. To retrieve a list of Dev Environment IDs, use
|
661
|
+
# ListDevEnvironments.
|
662
|
+
#
|
663
|
+
# @return [Types::DeleteDevEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
664
|
+
#
|
665
|
+
# * {Types::DeleteDevEnvironmentResponse#space_name #space_name} => String
|
666
|
+
# * {Types::DeleteDevEnvironmentResponse#project_name #project_name} => String
|
667
|
+
# * {Types::DeleteDevEnvironmentResponse#id #id} => String
|
668
|
+
#
|
669
|
+
# @example Request syntax with placeholder values
|
670
|
+
#
|
671
|
+
# resp = client.delete_dev_environment({
|
672
|
+
# space_name: "NameString", # required
|
673
|
+
# project_name: "NameString", # required
|
674
|
+
# id: "Uuid", # required
|
675
|
+
# })
|
676
|
+
#
|
677
|
+
# @example Response structure
|
678
|
+
#
|
679
|
+
# resp.space_name #=> String
|
680
|
+
# resp.project_name #=> String
|
681
|
+
# resp.id #=> String
|
682
|
+
#
|
683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/DeleteDevEnvironment AWS API Documentation
|
684
|
+
#
|
685
|
+
# @overload delete_dev_environment(params = {})
|
686
|
+
# @param [Hash] params ({})
|
687
|
+
def delete_dev_environment(params = {}, options = {})
|
688
|
+
req = build_request(:delete_dev_environment, params)
|
689
|
+
req.send_request(options)
|
690
|
+
end
|
691
|
+
|
692
|
+
# Returns information about a Dev Environment for a source repository in
|
693
|
+
# a project. Dev Environments are specific to the user who creates them.
|
694
|
+
#
|
695
|
+
# @option params [required, String] :space_name
|
696
|
+
# The name of the space.
|
697
|
+
#
|
698
|
+
# @option params [required, String] :project_name
|
699
|
+
# The name of the project in the space.
|
700
|
+
#
|
701
|
+
# @option params [required, String] :id
|
702
|
+
# The system-generated unique ID of the Dev Environment for which you
|
703
|
+
# want to view information. To retrieve a list of Dev Environment IDs,
|
704
|
+
# use ListDevEnvironments.
|
705
|
+
#
|
706
|
+
# @return [Types::GetDevEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
707
|
+
#
|
708
|
+
# * {Types::GetDevEnvironmentResponse#space_name #space_name} => String
|
709
|
+
# * {Types::GetDevEnvironmentResponse#project_name #project_name} => String
|
710
|
+
# * {Types::GetDevEnvironmentResponse#id #id} => String
|
711
|
+
# * {Types::GetDevEnvironmentResponse#last_updated_time #last_updated_time} => Time
|
712
|
+
# * {Types::GetDevEnvironmentResponse#creator_id #creator_id} => String
|
713
|
+
# * {Types::GetDevEnvironmentResponse#status #status} => String
|
714
|
+
# * {Types::GetDevEnvironmentResponse#status_reason #status_reason} => String
|
715
|
+
# * {Types::GetDevEnvironmentResponse#repositories #repositories} => Array<Types::DevEnvironmentRepositorySummary>
|
716
|
+
# * {Types::GetDevEnvironmentResponse#alias #alias} => String
|
717
|
+
# * {Types::GetDevEnvironmentResponse#ides #ides} => Array<Types::Ide>
|
718
|
+
# * {Types::GetDevEnvironmentResponse#instance_type #instance_type} => String
|
719
|
+
# * {Types::GetDevEnvironmentResponse#inactivity_timeout_minutes #inactivity_timeout_minutes} => Integer
|
720
|
+
# * {Types::GetDevEnvironmentResponse#persistent_storage #persistent_storage} => Types::PersistentStorage
|
721
|
+
#
|
722
|
+
# @example Request syntax with placeholder values
|
723
|
+
#
|
724
|
+
# resp = client.get_dev_environment({
|
725
|
+
# space_name: "NameString", # required
|
726
|
+
# project_name: "NameString", # required
|
727
|
+
# id: "Uuid", # required
|
728
|
+
# })
|
729
|
+
#
|
730
|
+
# @example Response structure
|
731
|
+
#
|
732
|
+
# resp.space_name #=> String
|
733
|
+
# resp.project_name #=> String
|
734
|
+
# resp.id #=> String
|
735
|
+
# resp.last_updated_time #=> Time
|
736
|
+
# resp.creator_id #=> String
|
737
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED"
|
738
|
+
# resp.status_reason #=> String
|
739
|
+
# resp.repositories #=> Array
|
740
|
+
# resp.repositories[0].repository_name #=> String
|
741
|
+
# resp.repositories[0].branch_name #=> String
|
742
|
+
# resp.alias #=> String
|
743
|
+
# resp.ides #=> Array
|
744
|
+
# resp.ides[0].runtime #=> String
|
745
|
+
# resp.ides[0].name #=> String
|
746
|
+
# resp.instance_type #=> String, one of "dev.standard1.small", "dev.standard1.medium", "dev.standard1.large", "dev.standard1.xlarge"
|
747
|
+
# resp.inactivity_timeout_minutes #=> Integer
|
748
|
+
# resp.persistent_storage.size_in_gi_b #=> Integer
|
749
|
+
#
|
750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetDevEnvironment AWS API Documentation
|
751
|
+
#
|
752
|
+
# @overload get_dev_environment(params = {})
|
753
|
+
# @param [Hash] params ({})
|
754
|
+
def get_dev_environment(params = {}, options = {})
|
755
|
+
req = build_request(:get_dev_environment, params)
|
756
|
+
req.send_request(options)
|
757
|
+
end
|
758
|
+
|
759
|
+
# Returns information about a project.
|
760
|
+
#
|
761
|
+
# @option params [required, String] :space_name
|
762
|
+
# The name of the space.
|
763
|
+
#
|
764
|
+
# @option params [required, String] :name
|
765
|
+
# The name of the project in the space.
|
766
|
+
#
|
767
|
+
# @return [Types::GetProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
768
|
+
#
|
769
|
+
# * {Types::GetProjectResponse#space_name #space_name} => String
|
770
|
+
# * {Types::GetProjectResponse#name #name} => String
|
771
|
+
# * {Types::GetProjectResponse#display_name #display_name} => String
|
772
|
+
# * {Types::GetProjectResponse#description #description} => String
|
773
|
+
#
|
774
|
+
# @example Request syntax with placeholder values
|
775
|
+
#
|
776
|
+
# resp = client.get_project({
|
777
|
+
# space_name: "NameString", # required
|
778
|
+
# name: "NameString", # required
|
779
|
+
# })
|
780
|
+
#
|
781
|
+
# @example Response structure
|
782
|
+
#
|
783
|
+
# resp.space_name #=> String
|
784
|
+
# resp.name #=> String
|
785
|
+
# resp.display_name #=> String
|
786
|
+
# resp.description #=> String
|
787
|
+
#
|
788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetProject AWS API Documentation
|
789
|
+
#
|
790
|
+
# @overload get_project(params = {})
|
791
|
+
# @param [Hash] params ({})
|
792
|
+
def get_project(params = {}, options = {})
|
793
|
+
req = build_request(:get_project, params)
|
794
|
+
req.send_request(options)
|
795
|
+
end
|
796
|
+
|
797
|
+
# Returns information about the URLs that can be used with a Git client
|
798
|
+
# to clone a source repository.
|
799
|
+
#
|
800
|
+
# @option params [required, String] :space_name
|
801
|
+
# The name of the space.
|
802
|
+
#
|
803
|
+
# @option params [required, String] :project_name
|
804
|
+
# The name of the project in the space.
|
805
|
+
#
|
806
|
+
# @option params [required, String] :source_repository_name
|
807
|
+
# The name of the source repository.
|
808
|
+
#
|
809
|
+
# @return [Types::GetSourceRepositoryCloneUrlsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
810
|
+
#
|
811
|
+
# * {Types::GetSourceRepositoryCloneUrlsResponse#https #https} => String
|
812
|
+
#
|
813
|
+
# @example Request syntax with placeholder values
|
814
|
+
#
|
815
|
+
# resp = client.get_source_repository_clone_urls({
|
816
|
+
# space_name: "NameString", # required
|
817
|
+
# project_name: "NameString", # required
|
818
|
+
# source_repository_name: "SourceRepositoryNameString", # required
|
819
|
+
# })
|
820
|
+
#
|
821
|
+
# @example Response structure
|
822
|
+
#
|
823
|
+
# resp.https #=> String
|
824
|
+
#
|
825
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetSourceRepositoryCloneUrls AWS API Documentation
|
826
|
+
#
|
827
|
+
# @overload get_source_repository_clone_urls(params = {})
|
828
|
+
# @param [Hash] params ({})
|
829
|
+
def get_source_repository_clone_urls(params = {}, options = {})
|
830
|
+
req = build_request(:get_source_repository_clone_urls, params)
|
831
|
+
req.send_request(options)
|
832
|
+
end
|
833
|
+
|
834
|
+
# Returns information about an space.
|
835
|
+
#
|
836
|
+
# @option params [required, String] :name
|
837
|
+
# The name of the space.
|
838
|
+
#
|
839
|
+
# @return [Types::GetSpaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
840
|
+
#
|
841
|
+
# * {Types::GetSpaceResponse#name #name} => String
|
842
|
+
# * {Types::GetSpaceResponse#region_name #region_name} => String
|
843
|
+
# * {Types::GetSpaceResponse#display_name #display_name} => String
|
844
|
+
# * {Types::GetSpaceResponse#description #description} => String
|
845
|
+
#
|
846
|
+
# @example Request syntax with placeholder values
|
847
|
+
#
|
848
|
+
# resp = client.get_space({
|
849
|
+
# name: "NameString", # required
|
850
|
+
# })
|
851
|
+
#
|
852
|
+
# @example Response structure
|
853
|
+
#
|
854
|
+
# resp.name #=> String
|
855
|
+
# resp.region_name #=> String
|
856
|
+
# resp.display_name #=> String
|
857
|
+
# resp.description #=> String
|
858
|
+
#
|
859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetSpace AWS API Documentation
|
860
|
+
#
|
861
|
+
# @overload get_space(params = {})
|
862
|
+
# @param [Hash] params ({})
|
863
|
+
def get_space(params = {}, options = {})
|
864
|
+
req = build_request(:get_space, params)
|
865
|
+
req.send_request(options)
|
866
|
+
end
|
867
|
+
|
868
|
+
# Returns information about the Amazon Web Services account used for
|
869
|
+
# billing purposes and the billing plan for the space.
|
870
|
+
#
|
871
|
+
# @option params [required, String] :space_name
|
872
|
+
# The name of the space.
|
873
|
+
#
|
874
|
+
# @return [Types::GetSubscriptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
875
|
+
#
|
876
|
+
# * {Types::GetSubscriptionResponse#subscription_type #subscription_type} => String
|
877
|
+
# * {Types::GetSubscriptionResponse#aws_account_name #aws_account_name} => String
|
878
|
+
#
|
879
|
+
# @example Request syntax with placeholder values
|
880
|
+
#
|
881
|
+
# resp = client.get_subscription({
|
882
|
+
# space_name: "NameString", # required
|
883
|
+
# })
|
884
|
+
#
|
885
|
+
# @example Response structure
|
886
|
+
#
|
887
|
+
# resp.subscription_type #=> String
|
888
|
+
# resp.aws_account_name #=> String
|
889
|
+
#
|
890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetSubscription AWS API Documentation
|
891
|
+
#
|
892
|
+
# @overload get_subscription(params = {})
|
893
|
+
# @param [Hash] params ({})
|
894
|
+
def get_subscription(params = {}, options = {})
|
895
|
+
req = build_request(:get_subscription, params)
|
896
|
+
req.send_request(options)
|
897
|
+
end
|
898
|
+
|
899
|
+
# Returns information about a user.
|
900
|
+
#
|
901
|
+
# @option params [String] :id
|
902
|
+
# The system-generated unique ID of the user.
|
903
|
+
#
|
904
|
+
# @option params [String] :user_name
|
905
|
+
# The name of the user as displayed in Amazon CodeCatalyst.
|
906
|
+
#
|
907
|
+
# @return [Types::GetUserDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
908
|
+
#
|
909
|
+
# * {Types::GetUserDetailsResponse#user_id #user_id} => String
|
910
|
+
# * {Types::GetUserDetailsResponse#user_name #user_name} => String
|
911
|
+
# * {Types::GetUserDetailsResponse#display_name #display_name} => String
|
912
|
+
# * {Types::GetUserDetailsResponse#primary_email #primary_email} => Types::EmailAddress
|
913
|
+
# * {Types::GetUserDetailsResponse#version #version} => String
|
914
|
+
#
|
915
|
+
# @example Request syntax with placeholder values
|
916
|
+
#
|
917
|
+
# resp = client.get_user_details({
|
918
|
+
# id: "GetUserDetailsRequestIdString",
|
919
|
+
# user_name: "GetUserDetailsRequestUserNameString",
|
920
|
+
# })
|
921
|
+
#
|
922
|
+
# @example Response structure
|
923
|
+
#
|
924
|
+
# resp.user_id #=> String
|
925
|
+
# resp.user_name #=> String
|
926
|
+
# resp.display_name #=> String
|
927
|
+
# resp.primary_email.email #=> String
|
928
|
+
# resp.primary_email.verified #=> Boolean
|
929
|
+
# resp.version #=> String
|
930
|
+
#
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/GetUserDetails AWS API Documentation
|
932
|
+
#
|
933
|
+
# @overload get_user_details(params = {})
|
934
|
+
# @param [Hash] params ({})
|
935
|
+
def get_user_details(params = {}, options = {})
|
936
|
+
req = build_request(:get_user_details, params)
|
937
|
+
req.send_request(options)
|
938
|
+
end
|
939
|
+
|
940
|
+
# Lists all personal access tokens (PATs) associated with the user who
|
941
|
+
# calls the API. You can only list PATs associated with your user
|
942
|
+
# account.
|
943
|
+
#
|
944
|
+
# @option params [Integer] :max_results
|
945
|
+
# The maximum number of results to show in a single call to this API. If
|
946
|
+
# the number of results is larger than the number you specified, the
|
947
|
+
# response will include a `NextToken` element, which you can use to
|
948
|
+
# obtain additional results.
|
949
|
+
#
|
950
|
+
# @option params [String] :next_token
|
951
|
+
# A token returned from a call to this API to indicate the next batch of
|
952
|
+
# results to return, if any.
|
953
|
+
#
|
954
|
+
# @return [Types::ListAccessTokensResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
955
|
+
#
|
956
|
+
# * {Types::ListAccessTokensResponse#items #items} => Array<Types::AccessTokenSummary>
|
957
|
+
# * {Types::ListAccessTokensResponse#next_token #next_token} => String
|
958
|
+
#
|
959
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
960
|
+
#
|
961
|
+
# @example Request syntax with placeholder values
|
962
|
+
#
|
963
|
+
# resp = client.list_access_tokens({
|
964
|
+
# max_results: 1,
|
965
|
+
# next_token: "ListAccessTokensRequestNextTokenString",
|
966
|
+
# })
|
967
|
+
#
|
968
|
+
# @example Response structure
|
969
|
+
#
|
970
|
+
# resp.items #=> Array
|
971
|
+
# resp.items[0].id #=> String
|
972
|
+
# resp.items[0].name #=> String
|
973
|
+
# resp.items[0].expires_time #=> Time
|
974
|
+
# resp.next_token #=> String
|
975
|
+
#
|
976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListAccessTokens AWS API Documentation
|
977
|
+
#
|
978
|
+
# @overload list_access_tokens(params = {})
|
979
|
+
# @param [Hash] params ({})
|
980
|
+
def list_access_tokens(params = {}, options = {})
|
981
|
+
req = build_request(:list_access_tokens, params)
|
982
|
+
req.send_request(options)
|
983
|
+
end
|
984
|
+
|
985
|
+
# Retrives a list of Dev Environments in a project.
|
986
|
+
#
|
987
|
+
# @option params [required, String] :space_name
|
988
|
+
# The name of the space.
|
989
|
+
#
|
990
|
+
# @option params [required, String] :project_name
|
991
|
+
# The name of the project in the space.
|
992
|
+
#
|
993
|
+
# @option params [Array<Types::Filter>] :filters
|
994
|
+
# Information about filters to apply to narrow the results returned in
|
995
|
+
# the list.
|
996
|
+
#
|
997
|
+
# @option params [String] :next_token
|
998
|
+
# A token returned from a call to this API to indicate the next batch of
|
999
|
+
# results to return, if any.
|
1000
|
+
#
|
1001
|
+
# @option params [Integer] :max_results
|
1002
|
+
# The maximum number of results to show in a single call to this API. If
|
1003
|
+
# the number of results is larger than the number you specified, the
|
1004
|
+
# response will include a `NextToken` element, which you can use to
|
1005
|
+
# obtain additional results.
|
1006
|
+
#
|
1007
|
+
# @return [Types::ListDevEnvironmentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1008
|
+
#
|
1009
|
+
# * {Types::ListDevEnvironmentsResponse#items #items} => Array<Types::DevEnvironmentSummary>
|
1010
|
+
# * {Types::ListDevEnvironmentsResponse#next_token #next_token} => String
|
1011
|
+
#
|
1012
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1013
|
+
#
|
1014
|
+
# @example Request syntax with placeholder values
|
1015
|
+
#
|
1016
|
+
# resp = client.list_dev_environments({
|
1017
|
+
# space_name: "NameString", # required
|
1018
|
+
# project_name: "NameString", # required
|
1019
|
+
# filters: [
|
1020
|
+
# {
|
1021
|
+
# key: "String", # required
|
1022
|
+
# values: ["String"], # required
|
1023
|
+
# comparison_operator: "String",
|
1024
|
+
# },
|
1025
|
+
# ],
|
1026
|
+
# next_token: "ListDevEnvironmentsRequestNextTokenString",
|
1027
|
+
# max_results: 1,
|
1028
|
+
# })
|
1029
|
+
#
|
1030
|
+
# @example Response structure
|
1031
|
+
#
|
1032
|
+
# resp.items #=> Array
|
1033
|
+
# resp.items[0].space_name #=> String
|
1034
|
+
# resp.items[0].project_name #=> String
|
1035
|
+
# resp.items[0].id #=> String
|
1036
|
+
# resp.items[0].last_updated_time #=> Time
|
1037
|
+
# resp.items[0].creator_id #=> String
|
1038
|
+
# resp.items[0].status #=> String, one of "PENDING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED"
|
1039
|
+
# resp.items[0].status_reason #=> String
|
1040
|
+
# resp.items[0].repositories #=> Array
|
1041
|
+
# resp.items[0].repositories[0].repository_name #=> String
|
1042
|
+
# resp.items[0].repositories[0].branch_name #=> String
|
1043
|
+
# resp.items[0].alias #=> String
|
1044
|
+
# resp.items[0].ides #=> Array
|
1045
|
+
# resp.items[0].ides[0].runtime #=> String
|
1046
|
+
# resp.items[0].ides[0].name #=> String
|
1047
|
+
# resp.items[0].instance_type #=> String, one of "dev.standard1.small", "dev.standard1.medium", "dev.standard1.large", "dev.standard1.xlarge"
|
1048
|
+
# resp.items[0].inactivity_timeout_minutes #=> Integer
|
1049
|
+
# resp.items[0].persistent_storage.size_in_gi_b #=> Integer
|
1050
|
+
# resp.next_token #=> String
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListDevEnvironments AWS API Documentation
|
1053
|
+
#
|
1054
|
+
# @overload list_dev_environments(params = {})
|
1055
|
+
# @param [Hash] params ({})
|
1056
|
+
def list_dev_environments(params = {}, options = {})
|
1057
|
+
req = build_request(:list_dev_environments, params)
|
1058
|
+
req.send_request(options)
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# Retrieves a list of events that occurred during a specified time
|
1062
|
+
# period in a space. You can use these events to audit user and system
|
1063
|
+
# activity in a space.
|
1064
|
+
#
|
1065
|
+
# @option params [required, String] :space_name
|
1066
|
+
# The name of the space.
|
1067
|
+
#
|
1068
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :start_time
|
1069
|
+
# The date and time when you want to start retrieving events, in
|
1070
|
+
# coordinated universal time (UTC) timestamp format as specified in [RFC
|
1071
|
+
# 3339][1].
|
1072
|
+
#
|
1073
|
+
#
|
1074
|
+
#
|
1075
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6
|
1076
|
+
#
|
1077
|
+
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
|
1078
|
+
# The time after which you do not want any events retrieved, in
|
1079
|
+
# coordinated universal time (UTC) timestamp format as specified in [RFC
|
1080
|
+
# 3339][1].
|
1081
|
+
#
|
1082
|
+
#
|
1083
|
+
#
|
1084
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc3339#section-5.6
|
1085
|
+
#
|
1086
|
+
# @option params [String] :event_name
|
1087
|
+
# The name of the event.
|
1088
|
+
#
|
1089
|
+
# @option params [String] :next_token
|
1090
|
+
# A token returned from a call to this API to indicate the next batch of
|
1091
|
+
# results to return, if any.
|
1092
|
+
#
|
1093
|
+
# @option params [Integer] :max_results
|
1094
|
+
# The maximum number of results to show in a single call to this API. If
|
1095
|
+
# the number of results is larger than the number you specified, the
|
1096
|
+
# response will include a `NextToken` element, which you can use to
|
1097
|
+
# obtain additional results.
|
1098
|
+
#
|
1099
|
+
# @return [Types::ListEventLogsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1100
|
+
#
|
1101
|
+
# * {Types::ListEventLogsResponse#next_token #next_token} => String
|
1102
|
+
# * {Types::ListEventLogsResponse#items #items} => Array<Types::EventLogEntry>
|
1103
|
+
#
|
1104
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1105
|
+
#
|
1106
|
+
# @example Request syntax with placeholder values
|
1107
|
+
#
|
1108
|
+
# resp = client.list_event_logs({
|
1109
|
+
# space_name: "NameString", # required
|
1110
|
+
# start_time: Time.now, # required
|
1111
|
+
# end_time: Time.now, # required
|
1112
|
+
# event_name: "String",
|
1113
|
+
# next_token: "ListEventLogsRequestNextTokenString",
|
1114
|
+
# max_results: 1,
|
1115
|
+
# })
|
1116
|
+
#
|
1117
|
+
# @example Response structure
|
1118
|
+
#
|
1119
|
+
# resp.next_token #=> String
|
1120
|
+
# resp.items #=> Array
|
1121
|
+
# resp.items[0].id #=> String
|
1122
|
+
# resp.items[0].event_name #=> String
|
1123
|
+
# resp.items[0].event_type #=> String
|
1124
|
+
# resp.items[0].event_category #=> String
|
1125
|
+
# resp.items[0].event_source #=> String
|
1126
|
+
# resp.items[0].event_time #=> Time
|
1127
|
+
# resp.items[0].operation_type #=> String, one of "READONLY", "MUTATION"
|
1128
|
+
# resp.items[0].user_identity.user_type #=> String, one of "USER", "AWS_ACCOUNT", "UNKNOWN"
|
1129
|
+
# resp.items[0].user_identity.principal_id #=> String
|
1130
|
+
# resp.items[0].user_identity.user_name #=> String
|
1131
|
+
# resp.items[0].user_identity.aws_account_id #=> String
|
1132
|
+
# resp.items[0].project_information.name #=> String
|
1133
|
+
# resp.items[0].project_information.project_id #=> String
|
1134
|
+
# resp.items[0].request_id #=> String
|
1135
|
+
# resp.items[0].request_payload.content_type #=> String
|
1136
|
+
# resp.items[0].request_payload.data #=> String
|
1137
|
+
# resp.items[0].response_payload.content_type #=> String
|
1138
|
+
# resp.items[0].response_payload.data #=> String
|
1139
|
+
# resp.items[0].error_code #=> String
|
1140
|
+
# resp.items[0].source_ip_address #=> String
|
1141
|
+
# resp.items[0].user_agent #=> String
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListEventLogs AWS API Documentation
|
1144
|
+
#
|
1145
|
+
# @overload list_event_logs(params = {})
|
1146
|
+
# @param [Hash] params ({})
|
1147
|
+
def list_event_logs(params = {}, options = {})
|
1148
|
+
req = build_request(:list_event_logs, params)
|
1149
|
+
req.send_request(options)
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# Retrieves a list of projects.
|
1153
|
+
#
|
1154
|
+
# @option params [required, String] :space_name
|
1155
|
+
# The name of the space.
|
1156
|
+
#
|
1157
|
+
# @option params [String] :next_token
|
1158
|
+
# A token returned from a call to this API to indicate the next batch of
|
1159
|
+
# results to return, if any.
|
1160
|
+
#
|
1161
|
+
# @option params [Integer] :max_results
|
1162
|
+
# The maximum number of results to show in a single call to this API. If
|
1163
|
+
# the number of results is larger than the number you specified, the
|
1164
|
+
# response will include a `NextToken` element, which you can use to
|
1165
|
+
# obtain additional results.
|
1166
|
+
#
|
1167
|
+
# @option params [Array<Types::ProjectListFilter>] :filters
|
1168
|
+
# Information about filters to apply to narrow the results returned in
|
1169
|
+
# the list.
|
1170
|
+
#
|
1171
|
+
# @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1172
|
+
#
|
1173
|
+
# * {Types::ListProjectsResponse#next_token #next_token} => String
|
1174
|
+
# * {Types::ListProjectsResponse#items #items} => Array<Types::ProjectSummary>
|
1175
|
+
#
|
1176
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1177
|
+
#
|
1178
|
+
# @example Request syntax with placeholder values
|
1179
|
+
#
|
1180
|
+
# resp = client.list_projects({
|
1181
|
+
# space_name: "NameString", # required
|
1182
|
+
# next_token: "ListProjectsRequestNextTokenString",
|
1183
|
+
# max_results: 1,
|
1184
|
+
# filters: [
|
1185
|
+
# {
|
1186
|
+
# key: "hasAccessTo", # required, accepts hasAccessTo
|
1187
|
+
# values: ["String"], # required
|
1188
|
+
# comparison_operator: "EQ", # accepts EQ, GT, GE, LT, LE
|
1189
|
+
# },
|
1190
|
+
# ],
|
1191
|
+
# })
|
1192
|
+
#
|
1193
|
+
# @example Response structure
|
1194
|
+
#
|
1195
|
+
# resp.next_token #=> String
|
1196
|
+
# resp.items #=> Array
|
1197
|
+
# resp.items[0].name #=> String
|
1198
|
+
# resp.items[0].display_name #=> String
|
1199
|
+
# resp.items[0].description #=> String
|
1200
|
+
#
|
1201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListProjects AWS API Documentation
|
1202
|
+
#
|
1203
|
+
# @overload list_projects(params = {})
|
1204
|
+
# @param [Hash] params ({})
|
1205
|
+
def list_projects(params = {}, options = {})
|
1206
|
+
req = build_request(:list_projects, params)
|
1207
|
+
req.send_request(options)
|
1208
|
+
end
|
1209
|
+
|
1210
|
+
# Retrieves a list of source repositories in a project.
|
1211
|
+
#
|
1212
|
+
# @option params [required, String] :space_name
|
1213
|
+
# The name of the space.
|
1214
|
+
#
|
1215
|
+
# @option params [required, String] :project_name
|
1216
|
+
# The name of the project in the space.
|
1217
|
+
#
|
1218
|
+
# @option params [String] :next_token
|
1219
|
+
# A token returned from a call to this API to indicate the next batch of
|
1220
|
+
# results to return, if any.
|
1221
|
+
#
|
1222
|
+
# @option params [Integer] :max_results
|
1223
|
+
# The maximum number of results to show in a single call to this API. If
|
1224
|
+
# the number of results is larger than the number you specified, the
|
1225
|
+
# response will include a `NextToken` element, which you can use to
|
1226
|
+
# obtain additional results.
|
1227
|
+
#
|
1228
|
+
# @return [Types::ListSourceRepositoriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1229
|
+
#
|
1230
|
+
# * {Types::ListSourceRepositoriesResponse#items #items} => Array<Types::ListSourceRepositoriesItem>
|
1231
|
+
# * {Types::ListSourceRepositoriesResponse#next_token #next_token} => String
|
1232
|
+
#
|
1233
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1234
|
+
#
|
1235
|
+
# @example Request syntax with placeholder values
|
1236
|
+
#
|
1237
|
+
# resp = client.list_source_repositories({
|
1238
|
+
# space_name: "NameString", # required
|
1239
|
+
# project_name: "NameString", # required
|
1240
|
+
# next_token: "ListSourceRepositoriesRequestNextTokenString",
|
1241
|
+
# max_results: 1,
|
1242
|
+
# })
|
1243
|
+
#
|
1244
|
+
# @example Response structure
|
1245
|
+
#
|
1246
|
+
# resp.items #=> Array
|
1247
|
+
# resp.items[0].id #=> String
|
1248
|
+
# resp.items[0].name #=> String
|
1249
|
+
# resp.items[0].description #=> String
|
1250
|
+
# resp.items[0].last_updated_time #=> Time
|
1251
|
+
# resp.items[0].created_time #=> Time
|
1252
|
+
# resp.next_token #=> String
|
1253
|
+
#
|
1254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListSourceRepositories AWS API Documentation
|
1255
|
+
#
|
1256
|
+
# @overload list_source_repositories(params = {})
|
1257
|
+
# @param [Hash] params ({})
|
1258
|
+
def list_source_repositories(params = {}, options = {})
|
1259
|
+
req = build_request(:list_source_repositories, params)
|
1260
|
+
req.send_request(options)
|
1261
|
+
end
|
1262
|
+
|
1263
|
+
# Retrieves a list of branches in a specified source repository.
|
1264
|
+
#
|
1265
|
+
# @option params [required, String] :space_name
|
1266
|
+
# The name of the space.
|
1267
|
+
#
|
1268
|
+
# @option params [required, String] :project_name
|
1269
|
+
# The name of the project in the space.
|
1270
|
+
#
|
1271
|
+
# @option params [required, String] :source_repository_name
|
1272
|
+
# The name of the source repository.
|
1273
|
+
#
|
1274
|
+
# @option params [String] :next_token
|
1275
|
+
# A token returned from a call to this API to indicate the next batch of
|
1276
|
+
# results to return, if any.
|
1277
|
+
#
|
1278
|
+
# @option params [Integer] :max_results
|
1279
|
+
# The maximum number of results to show in a single call to this API. If
|
1280
|
+
# the number of results is larger than the number you specified, the
|
1281
|
+
# response will include a `NextToken` element, which you can use to
|
1282
|
+
# obtain additional results.
|
1283
|
+
#
|
1284
|
+
# @return [Types::ListSourceRepositoryBranchesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1285
|
+
#
|
1286
|
+
# * {Types::ListSourceRepositoryBranchesResponse#next_token #next_token} => String
|
1287
|
+
# * {Types::ListSourceRepositoryBranchesResponse#items #items} => Array<Types::ListSourceRepositoryBranchesItem>
|
1288
|
+
#
|
1289
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1290
|
+
#
|
1291
|
+
# @example Request syntax with placeholder values
|
1292
|
+
#
|
1293
|
+
# resp = client.list_source_repository_branches({
|
1294
|
+
# space_name: "NameString", # required
|
1295
|
+
# project_name: "NameString", # required
|
1296
|
+
# source_repository_name: "SourceRepositoryNameString", # required
|
1297
|
+
# next_token: "ListSourceRepositoryBranchesRequestNextTokenString",
|
1298
|
+
# max_results: 1,
|
1299
|
+
# })
|
1300
|
+
#
|
1301
|
+
# @example Response structure
|
1302
|
+
#
|
1303
|
+
# resp.next_token #=> String
|
1304
|
+
# resp.items #=> Array
|
1305
|
+
# resp.items[0].ref #=> String
|
1306
|
+
# resp.items[0].name #=> String
|
1307
|
+
# resp.items[0].last_updated_time #=> Time
|
1308
|
+
# resp.items[0].head_commit_id #=> String
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListSourceRepositoryBranches AWS API Documentation
|
1311
|
+
#
|
1312
|
+
# @overload list_source_repository_branches(params = {})
|
1313
|
+
# @param [Hash] params ({})
|
1314
|
+
def list_source_repository_branches(params = {}, options = {})
|
1315
|
+
req = build_request(:list_source_repository_branches, params)
|
1316
|
+
req.send_request(options)
|
1317
|
+
end
|
1318
|
+
|
1319
|
+
# Retrieves a list of spaces.
|
1320
|
+
#
|
1321
|
+
# @option params [String] :next_token
|
1322
|
+
# A token returned from a call to this API to indicate the next batch of
|
1323
|
+
# results to return, if any.
|
1324
|
+
#
|
1325
|
+
# @return [Types::ListSpacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1326
|
+
#
|
1327
|
+
# * {Types::ListSpacesResponse#next_token #next_token} => String
|
1328
|
+
# * {Types::ListSpacesResponse#items #items} => Array<Types::SpaceSummary>
|
1329
|
+
#
|
1330
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1331
|
+
#
|
1332
|
+
# @example Request syntax with placeholder values
|
1333
|
+
#
|
1334
|
+
# resp = client.list_spaces({
|
1335
|
+
# next_token: "ListSpacesRequestNextTokenString",
|
1336
|
+
# })
|
1337
|
+
#
|
1338
|
+
# @example Response structure
|
1339
|
+
#
|
1340
|
+
# resp.next_token #=> String
|
1341
|
+
# resp.items #=> Array
|
1342
|
+
# resp.items[0].name #=> String
|
1343
|
+
# resp.items[0].region_name #=> String
|
1344
|
+
# resp.items[0].display_name #=> String
|
1345
|
+
# resp.items[0].description #=> String
|
1346
|
+
#
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/ListSpaces AWS API Documentation
|
1348
|
+
#
|
1349
|
+
# @overload list_spaces(params = {})
|
1350
|
+
# @param [Hash] params ({})
|
1351
|
+
def list_spaces(params = {}, options = {})
|
1352
|
+
req = build_request(:list_spaces, params)
|
1353
|
+
req.send_request(options)
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
# Starts a specified Dev Environment and puts it into an active state.
|
1357
|
+
#
|
1358
|
+
# @option params [required, String] :space_name
|
1359
|
+
# The name of the space.
|
1360
|
+
#
|
1361
|
+
# @option params [required, String] :project_name
|
1362
|
+
# The name of the project in the space.
|
1363
|
+
#
|
1364
|
+
# @option params [required, String] :id
|
1365
|
+
# The system-generated unique ID of the Dev Environment.
|
1366
|
+
#
|
1367
|
+
# @option params [Array<Types::IdeConfiguration>] :ides
|
1368
|
+
# Information about the integrated development environment (IDE)
|
1369
|
+
# configured for a Dev Environment.
|
1370
|
+
#
|
1371
|
+
# @option params [String] :instance_type
|
1372
|
+
# The Amazon EC2 instace type to use for the Dev Environment.
|
1373
|
+
#
|
1374
|
+
# @option params [Integer] :inactivity_timeout_minutes
|
1375
|
+
# The amount of time the Dev Environment will run without any activity
|
1376
|
+
# detected before stopping, in minutes. Only whole integers are allowed.
|
1377
|
+
# Dev Environments consume compute minutes when running.
|
1378
|
+
#
|
1379
|
+
# @return [Types::StartDevEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1380
|
+
#
|
1381
|
+
# * {Types::StartDevEnvironmentResponse#space_name #space_name} => String
|
1382
|
+
# * {Types::StartDevEnvironmentResponse#project_name #project_name} => String
|
1383
|
+
# * {Types::StartDevEnvironmentResponse#id #id} => String
|
1384
|
+
# * {Types::StartDevEnvironmentResponse#status #status} => String
|
1385
|
+
#
|
1386
|
+
# @example Request syntax with placeholder values
|
1387
|
+
#
|
1388
|
+
# resp = client.start_dev_environment({
|
1389
|
+
# space_name: "NameString", # required
|
1390
|
+
# project_name: "NameString", # required
|
1391
|
+
# id: "Uuid", # required
|
1392
|
+
# ides: [
|
1393
|
+
# {
|
1394
|
+
# runtime: "IdeConfigurationRuntimeString",
|
1395
|
+
# name: "IdeConfigurationNameString",
|
1396
|
+
# },
|
1397
|
+
# ],
|
1398
|
+
# instance_type: "dev.standard1.small", # accepts dev.standard1.small, dev.standard1.medium, dev.standard1.large, dev.standard1.xlarge
|
1399
|
+
# inactivity_timeout_minutes: 1,
|
1400
|
+
# })
|
1401
|
+
#
|
1402
|
+
# @example Response structure
|
1403
|
+
#
|
1404
|
+
# resp.space_name #=> String
|
1405
|
+
# resp.project_name #=> String
|
1406
|
+
# resp.id #=> String
|
1407
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED"
|
1408
|
+
#
|
1409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/StartDevEnvironment AWS API Documentation
|
1410
|
+
#
|
1411
|
+
# @overload start_dev_environment(params = {})
|
1412
|
+
# @param [Hash] params ({})
|
1413
|
+
def start_dev_environment(params = {}, options = {})
|
1414
|
+
req = build_request(:start_dev_environment, params)
|
1415
|
+
req.send_request(options)
|
1416
|
+
end
|
1417
|
+
|
1418
|
+
# Starts a session for a specified Dev Environment.
|
1419
|
+
#
|
1420
|
+
# @option params [required, String] :space_name
|
1421
|
+
# The name of the space.
|
1422
|
+
#
|
1423
|
+
# @option params [required, String] :project_name
|
1424
|
+
# The name of the project in the space.
|
1425
|
+
#
|
1426
|
+
# @option params [required, String] :id
|
1427
|
+
# The system-generated unique ID of the Dev Environment.
|
1428
|
+
#
|
1429
|
+
# @option params [required, Types::DevEnvironmentSessionConfiguration] :session_configuration
|
1430
|
+
# Information about the configuration of a Dev Environment session.
|
1431
|
+
#
|
1432
|
+
# @return [Types::StartDevEnvironmentSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1433
|
+
#
|
1434
|
+
# * {Types::StartDevEnvironmentSessionResponse#access_details #access_details} => Types::DevEnvironmentAccessDetails
|
1435
|
+
# * {Types::StartDevEnvironmentSessionResponse#session_id #session_id} => String
|
1436
|
+
# * {Types::StartDevEnvironmentSessionResponse#space_name #space_name} => String
|
1437
|
+
# * {Types::StartDevEnvironmentSessionResponse#project_name #project_name} => String
|
1438
|
+
# * {Types::StartDevEnvironmentSessionResponse#id #id} => String
|
1439
|
+
#
|
1440
|
+
# @example Request syntax with placeholder values
|
1441
|
+
#
|
1442
|
+
# resp = client.start_dev_environment_session({
|
1443
|
+
# space_name: "NameString", # required
|
1444
|
+
# project_name: "NameString", # required
|
1445
|
+
# id: "Uuid", # required
|
1446
|
+
# session_configuration: { # required
|
1447
|
+
# session_type: "SSM", # required, accepts SSM, SSH
|
1448
|
+
# execute_command_session_configuration: {
|
1449
|
+
# command: "ExecuteCommandSessionConfigurationCommandString", # required
|
1450
|
+
# arguments: ["ExecuteCommandSessionConfigurationArgumentsMemberString"],
|
1451
|
+
# },
|
1452
|
+
# },
|
1453
|
+
# })
|
1454
|
+
#
|
1455
|
+
# @example Response structure
|
1456
|
+
#
|
1457
|
+
# resp.access_details.stream_url #=> String
|
1458
|
+
# resp.access_details.token_value #=> String
|
1459
|
+
# resp.session_id #=> String
|
1460
|
+
# resp.space_name #=> String
|
1461
|
+
# resp.project_name #=> String
|
1462
|
+
# resp.id #=> String
|
1463
|
+
#
|
1464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/StartDevEnvironmentSession AWS API Documentation
|
1465
|
+
#
|
1466
|
+
# @overload start_dev_environment_session(params = {})
|
1467
|
+
# @param [Hash] params ({})
|
1468
|
+
def start_dev_environment_session(params = {}, options = {})
|
1469
|
+
req = build_request(:start_dev_environment_session, params)
|
1470
|
+
req.send_request(options)
|
1471
|
+
end
|
1472
|
+
|
1473
|
+
# Pauses a specified Dev Environment and places it in a non-running
|
1474
|
+
# state. Stopped Dev Environments do not consume compute minutes.
|
1475
|
+
#
|
1476
|
+
# @option params [required, String] :space_name
|
1477
|
+
# The name of the space.
|
1478
|
+
#
|
1479
|
+
# @option params [required, String] :project_name
|
1480
|
+
# The name of the project in the space.
|
1481
|
+
#
|
1482
|
+
# @option params [required, String] :id
|
1483
|
+
# The system-generated unique ID of the Dev Environment.
|
1484
|
+
#
|
1485
|
+
# @return [Types::StopDevEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1486
|
+
#
|
1487
|
+
# * {Types::StopDevEnvironmentResponse#space_name #space_name} => String
|
1488
|
+
# * {Types::StopDevEnvironmentResponse#project_name #project_name} => String
|
1489
|
+
# * {Types::StopDevEnvironmentResponse#id #id} => String
|
1490
|
+
# * {Types::StopDevEnvironmentResponse#status #status} => String
|
1491
|
+
#
|
1492
|
+
# @example Request syntax with placeholder values
|
1493
|
+
#
|
1494
|
+
# resp = client.stop_dev_environment({
|
1495
|
+
# space_name: "NameString", # required
|
1496
|
+
# project_name: "NameString", # required
|
1497
|
+
# id: "Uuid", # required
|
1498
|
+
# })
|
1499
|
+
#
|
1500
|
+
# @example Response structure
|
1501
|
+
#
|
1502
|
+
# resp.space_name #=> String
|
1503
|
+
# resp.project_name #=> String
|
1504
|
+
# resp.id #=> String
|
1505
|
+
# resp.status #=> String, one of "PENDING", "RUNNING", "STARTING", "STOPPING", "STOPPED", "FAILED", "DELETING", "DELETED"
|
1506
|
+
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/StopDevEnvironment AWS API Documentation
|
1508
|
+
#
|
1509
|
+
# @overload stop_dev_environment(params = {})
|
1510
|
+
# @param [Hash] params ({})
|
1511
|
+
def stop_dev_environment(params = {}, options = {})
|
1512
|
+
req = build_request(:stop_dev_environment, params)
|
1513
|
+
req.send_request(options)
|
1514
|
+
end
|
1515
|
+
|
1516
|
+
# Changes one or more values for a Dev Environment. Updating certain
|
1517
|
+
# values of the Dev Environment will cause a restart.
|
1518
|
+
#
|
1519
|
+
# @option params [required, String] :space_name
|
1520
|
+
# The name of the space.
|
1521
|
+
#
|
1522
|
+
# @option params [required, String] :project_name
|
1523
|
+
# The name of the project in the space.
|
1524
|
+
#
|
1525
|
+
# @option params [required, String] :id
|
1526
|
+
# The system-generated unique ID of the Dev Environment.
|
1527
|
+
#
|
1528
|
+
# @option params [String] :alias
|
1529
|
+
# The user-specified alias for the Dev Environment. Changing this value
|
1530
|
+
# will not cause a restart.
|
1531
|
+
#
|
1532
|
+
# @option params [Array<Types::IdeConfiguration>] :ides
|
1533
|
+
# Information about the integrated development environment (IDE)
|
1534
|
+
# configured for a Dev Environment.
|
1535
|
+
#
|
1536
|
+
# @option params [String] :instance_type
|
1537
|
+
# The Amazon EC2 instace type to use for the Dev Environment.
|
1538
|
+
#
|
1539
|
+
# <note markdown="1"> Changing this value will cause a restart of the Dev Environment if it
|
1540
|
+
# is running.
|
1541
|
+
#
|
1542
|
+
# </note>
|
1543
|
+
#
|
1544
|
+
# @option params [Integer] :inactivity_timeout_minutes
|
1545
|
+
# The amount of time the Dev Environment will run without any activity
|
1546
|
+
# detected before stopping, in minutes. Only whole integers are allowed.
|
1547
|
+
# Dev Environments consume compute minutes when running.
|
1548
|
+
#
|
1549
|
+
# <note markdown="1"> Changing this value will cause a restart of the Dev Environment if it
|
1550
|
+
# is running.
|
1551
|
+
#
|
1552
|
+
# </note>
|
1553
|
+
#
|
1554
|
+
# @option params [String] :client_token
|
1555
|
+
# A user-specified idempotency token. Idempotency ensures that an API
|
1556
|
+
# request completes only once. With an idempotent request, if the
|
1557
|
+
# original request completes successfully, the subsequent retries return
|
1558
|
+
# the result from the original successful request and have no additional
|
1559
|
+
# effect.
|
1560
|
+
#
|
1561
|
+
# @return [Types::UpdateDevEnvironmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1562
|
+
#
|
1563
|
+
# * {Types::UpdateDevEnvironmentResponse#id #id} => String
|
1564
|
+
# * {Types::UpdateDevEnvironmentResponse#space_name #space_name} => String
|
1565
|
+
# * {Types::UpdateDevEnvironmentResponse#project_name #project_name} => String
|
1566
|
+
# * {Types::UpdateDevEnvironmentResponse#alias #alias} => String
|
1567
|
+
# * {Types::UpdateDevEnvironmentResponse#ides #ides} => Array<Types::IdeConfiguration>
|
1568
|
+
# * {Types::UpdateDevEnvironmentResponse#instance_type #instance_type} => String
|
1569
|
+
# * {Types::UpdateDevEnvironmentResponse#inactivity_timeout_minutes #inactivity_timeout_minutes} => Integer
|
1570
|
+
# * {Types::UpdateDevEnvironmentResponse#client_token #client_token} => String
|
1571
|
+
#
|
1572
|
+
# @example Request syntax with placeholder values
|
1573
|
+
#
|
1574
|
+
# resp = client.update_dev_environment({
|
1575
|
+
# space_name: "NameString", # required
|
1576
|
+
# project_name: "NameString", # required
|
1577
|
+
# id: "Uuid", # required
|
1578
|
+
# alias: "UpdateDevEnvironmentRequestAliasString",
|
1579
|
+
# ides: [
|
1580
|
+
# {
|
1581
|
+
# runtime: "IdeConfigurationRuntimeString",
|
1582
|
+
# name: "IdeConfigurationNameString",
|
1583
|
+
# },
|
1584
|
+
# ],
|
1585
|
+
# instance_type: "dev.standard1.small", # accepts dev.standard1.small, dev.standard1.medium, dev.standard1.large, dev.standard1.xlarge
|
1586
|
+
# inactivity_timeout_minutes: 1,
|
1587
|
+
# client_token: "ClientToken",
|
1588
|
+
# })
|
1589
|
+
#
|
1590
|
+
# @example Response structure
|
1591
|
+
#
|
1592
|
+
# resp.id #=> String
|
1593
|
+
# resp.space_name #=> String
|
1594
|
+
# resp.project_name #=> String
|
1595
|
+
# resp.alias #=> String
|
1596
|
+
# resp.ides #=> Array
|
1597
|
+
# resp.ides[0].runtime #=> String
|
1598
|
+
# resp.ides[0].name #=> String
|
1599
|
+
# resp.instance_type #=> String, one of "dev.standard1.small", "dev.standard1.medium", "dev.standard1.large", "dev.standard1.xlarge"
|
1600
|
+
# resp.inactivity_timeout_minutes #=> Integer
|
1601
|
+
# resp.client_token #=> String
|
1602
|
+
#
|
1603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/UpdateDevEnvironment AWS API Documentation
|
1604
|
+
#
|
1605
|
+
# @overload update_dev_environment(params = {})
|
1606
|
+
# @param [Hash] params ({})
|
1607
|
+
def update_dev_environment(params = {}, options = {})
|
1608
|
+
req = build_request(:update_dev_environment, params)
|
1609
|
+
req.send_request(options)
|
1610
|
+
end
|
1611
|
+
|
1612
|
+
# Verifies whether the calling user has a valid Amazon CodeCatalyst
|
1613
|
+
# login and session. If successful, this returns the ID of the user in
|
1614
|
+
# Amazon CodeCatalyst.
|
1615
|
+
#
|
1616
|
+
# @return [Types::VerifySessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1617
|
+
#
|
1618
|
+
# * {Types::VerifySessionResponse#identity #identity} => String
|
1619
|
+
#
|
1620
|
+
# @example Response structure
|
1621
|
+
#
|
1622
|
+
# resp.identity #=> String
|
1623
|
+
#
|
1624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codecatalyst-2022-09-28/VerifySession AWS API Documentation
|
1625
|
+
#
|
1626
|
+
# @overload verify_session(params = {})
|
1627
|
+
# @param [Hash] params ({})
|
1628
|
+
def verify_session(params = {}, options = {})
|
1629
|
+
req = build_request(:verify_session, params)
|
1630
|
+
req.send_request(options)
|
1631
|
+
end
|
1632
|
+
|
1633
|
+
# @!endgroup
|
1634
|
+
|
1635
|
+
# @param params ({})
|
1636
|
+
# @api private
|
1637
|
+
def build_request(operation_name, params = {})
|
1638
|
+
handlers = @handlers.for(operation_name)
|
1639
|
+
context = Seahorse::Client::RequestContext.new(
|
1640
|
+
operation_name: operation_name,
|
1641
|
+
operation: config.api.operation(operation_name),
|
1642
|
+
client: self,
|
1643
|
+
params: params,
|
1644
|
+
config: config)
|
1645
|
+
context[:gem_name] = 'aws-sdk-codecatalyst'
|
1646
|
+
context[:gem_version] = '1.0.0'
|
1647
|
+
Seahorse::Client::Request.new(handlers, context)
|
1648
|
+
end
|
1649
|
+
|
1650
|
+
# @api private
|
1651
|
+
# @deprecated
|
1652
|
+
def waiter_names
|
1653
|
+
[]
|
1654
|
+
end
|
1655
|
+
|
1656
|
+
class << self
|
1657
|
+
|
1658
|
+
# @api private
|
1659
|
+
attr_reader :identifier
|
1660
|
+
|
1661
|
+
# @api private
|
1662
|
+
def errors_module
|
1663
|
+
Errors
|
1664
|
+
end
|
1665
|
+
|
1666
|
+
end
|
1667
|
+
end
|
1668
|
+
end
|