aws-sdk-proton 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.
File without changes
@@ -0,0 +1,162 @@
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
+ module Aws::Proton
11
+
12
+ # When Proton returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::Proton::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all Proton errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::Proton::Errors::ServiceError
20
+ # # rescues all Proton API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {AccessDeniedException}
31
+ # * {ConflictException}
32
+ # * {InternalServerException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ServiceQuotaExceededException}
35
+ # * {ThrottlingException}
36
+ # * {ValidationException}
37
+ #
38
+ # Additionally, error classes are dynamically generated for service errors based on the error code
39
+ # if they are not defined above.
40
+ module Errors
41
+
42
+ extend Aws::Errors::DynamicErrors
43
+
44
+ class AccessDeniedException < ServiceError
45
+
46
+ # @param [Seahorse::Client::RequestContext] context
47
+ # @param [String] message
48
+ # @param [Aws::Proton::Types::AccessDeniedException] data
49
+ def initialize(context, message, data = Aws::EmptyStructure.new)
50
+ super(context, message, data)
51
+ end
52
+
53
+ # @return [String]
54
+ def message
55
+ @message || @data[:message]
56
+ end
57
+ end
58
+
59
+ class ConflictException < ServiceError
60
+
61
+ # @param [Seahorse::Client::RequestContext] context
62
+ # @param [String] message
63
+ # @param [Aws::Proton::Types::ConflictException] data
64
+ def initialize(context, message, data = Aws::EmptyStructure.new)
65
+ super(context, message, data)
66
+ end
67
+
68
+ # @return [String]
69
+ def message
70
+ @message || @data[:message]
71
+ end
72
+ end
73
+
74
+ class InternalServerException < ServiceError
75
+
76
+ # @param [Seahorse::Client::RequestContext] context
77
+ # @param [String] message
78
+ # @param [Aws::Proton::Types::InternalServerException] data
79
+ def initialize(context, message, data = Aws::EmptyStructure.new)
80
+ super(context, message, data)
81
+ end
82
+
83
+ # @return [String]
84
+ def message
85
+ @message || @data[:message]
86
+ end
87
+
88
+ def retryable?
89
+ true
90
+ end
91
+ end
92
+
93
+ class ResourceNotFoundException < ServiceError
94
+
95
+ # @param [Seahorse::Client::RequestContext] context
96
+ # @param [String] message
97
+ # @param [Aws::Proton::Types::ResourceNotFoundException] data
98
+ def initialize(context, message, data = Aws::EmptyStructure.new)
99
+ super(context, message, data)
100
+ end
101
+
102
+ # @return [String]
103
+ def message
104
+ @message || @data[:message]
105
+ end
106
+ end
107
+
108
+ class ServiceQuotaExceededException < ServiceError
109
+
110
+ # @param [Seahorse::Client::RequestContext] context
111
+ # @param [String] message
112
+ # @param [Aws::Proton::Types::ServiceQuotaExceededException] data
113
+ def initialize(context, message, data = Aws::EmptyStructure.new)
114
+ super(context, message, data)
115
+ end
116
+
117
+ # @return [String]
118
+ def message
119
+ @message || @data[:message]
120
+ end
121
+ end
122
+
123
+ class ThrottlingException < ServiceError
124
+
125
+ # @param [Seahorse::Client::RequestContext] context
126
+ # @param [String] message
127
+ # @param [Aws::Proton::Types::ThrottlingException] data
128
+ def initialize(context, message, data = Aws::EmptyStructure.new)
129
+ super(context, message, data)
130
+ end
131
+
132
+ # @return [String]
133
+ def message
134
+ @message || @data[:message]
135
+ end
136
+
137
+ def retryable?
138
+ true
139
+ end
140
+
141
+ def throttling?
142
+ true
143
+ end
144
+ end
145
+
146
+ class ValidationException < ServiceError
147
+
148
+ # @param [Seahorse::Client::RequestContext] context
149
+ # @param [String] message
150
+ # @param [Aws::Proton::Types::ValidationException] data
151
+ def initialize(context, message, data = Aws::EmptyStructure.new)
152
+ super(context, message, data)
153
+ end
154
+
155
+ # @return [String]
156
+ def message
157
+ @message || @data[:message]
158
+ end
159
+ end
160
+
161
+ end
162
+ end
@@ -0,0 +1,26 @@
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
+ module Aws::Proton
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,3956 @@
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
+ module Aws::Proton
11
+ module Types
12
+
13
+ # @note When making an API call, you may pass AcceptEnvironmentAccountConnectionInput
14
+ # data as a hash:
15
+ #
16
+ # {
17
+ # id: "EnvironmentAccountConnectionId", # required
18
+ # }
19
+ #
20
+ # @!attribute [rw] id
21
+ # The ID of the environment account connection.
22
+ # @return [String]
23
+ #
24
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AcceptEnvironmentAccountConnectionInput AWS API Documentation
25
+ #
26
+ class AcceptEnvironmentAccountConnectionInput < Struct.new(
27
+ :id)
28
+ SENSITIVE = []
29
+ include Aws::Structure
30
+ end
31
+
32
+ # @!attribute [rw] environment_account_connection
33
+ # The environment account connection data that's returned by AWS
34
+ # Proton.
35
+ # @return [Types::EnvironmentAccountConnection]
36
+ #
37
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AcceptEnvironmentAccountConnectionOutput AWS API Documentation
38
+ #
39
+ class AcceptEnvironmentAccountConnectionOutput < Struct.new(
40
+ :environment_account_connection)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
45
+ # There *isn't* sufficient access for performing this action.
46
+ #
47
+ # @!attribute [rw] message
48
+ # @return [String]
49
+ #
50
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AccessDeniedException AWS API Documentation
51
+ #
52
+ class AccessDeniedException < Struct.new(
53
+ :message)
54
+ SENSITIVE = [:message]
55
+ include Aws::Structure
56
+ end
57
+
58
+ # The AWS Proton pipeline service role data.
59
+ #
60
+ # @!attribute [rw] pipeline_service_role_arn
61
+ # The Amazon Resource Name (ARN) of the AWS Proton pipeline service
62
+ # role.
63
+ # @return [String]
64
+ #
65
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AccountSettings AWS API Documentation
66
+ #
67
+ class AccountSettings < Struct.new(
68
+ :pipeline_service_role_arn)
69
+ SENSITIVE = []
70
+ include Aws::Structure
71
+ end
72
+
73
+ # @note When making an API call, you may pass CancelEnvironmentDeploymentInput
74
+ # data as a hash:
75
+ #
76
+ # {
77
+ # environment_name: "ResourceName", # required
78
+ # }
79
+ #
80
+ # @!attribute [rw] environment_name
81
+ # The name of the environment with the deployment to cancel.
82
+ # @return [String]
83
+ #
84
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelEnvironmentDeploymentInput AWS API Documentation
85
+ #
86
+ class CancelEnvironmentDeploymentInput < Struct.new(
87
+ :environment_name)
88
+ SENSITIVE = []
89
+ include Aws::Structure
90
+ end
91
+
92
+ # @!attribute [rw] environment
93
+ # The environment summary data that's returned by AWS Proton.
94
+ # @return [Types::Environment]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelEnvironmentDeploymentOutput AWS API Documentation
97
+ #
98
+ class CancelEnvironmentDeploymentOutput < Struct.new(
99
+ :environment)
100
+ SENSITIVE = []
101
+ include Aws::Structure
102
+ end
103
+
104
+ # @note When making an API call, you may pass CancelServiceInstanceDeploymentInput
105
+ # data as a hash:
106
+ #
107
+ # {
108
+ # service_instance_name: "ResourceName", # required
109
+ # service_name: "ResourceName", # required
110
+ # }
111
+ #
112
+ # @!attribute [rw] service_instance_name
113
+ # The name of the service instance with the deployment to cancel.
114
+ # @return [String]
115
+ #
116
+ # @!attribute [rw] service_name
117
+ # The name of the service with the service instance deployment to
118
+ # cancel.
119
+ # @return [String]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServiceInstanceDeploymentInput AWS API Documentation
122
+ #
123
+ class CancelServiceInstanceDeploymentInput < Struct.new(
124
+ :service_instance_name,
125
+ :service_name)
126
+ SENSITIVE = []
127
+ include Aws::Structure
128
+ end
129
+
130
+ # @!attribute [rw] service_instance
131
+ # The service instance summary data that's returned by AWS Proton.
132
+ # @return [Types::ServiceInstance]
133
+ #
134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServiceInstanceDeploymentOutput AWS API Documentation
135
+ #
136
+ class CancelServiceInstanceDeploymentOutput < Struct.new(
137
+ :service_instance)
138
+ SENSITIVE = []
139
+ include Aws::Structure
140
+ end
141
+
142
+ # @note When making an API call, you may pass CancelServicePipelineDeploymentInput
143
+ # data as a hash:
144
+ #
145
+ # {
146
+ # service_name: "ResourceName", # required
147
+ # }
148
+ #
149
+ # @!attribute [rw] service_name
150
+ # The name of the service with the service pipeline deployment to
151
+ # cancel.
152
+ # @return [String]
153
+ #
154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServicePipelineDeploymentInput AWS API Documentation
155
+ #
156
+ class CancelServicePipelineDeploymentInput < Struct.new(
157
+ :service_name)
158
+ SENSITIVE = []
159
+ include Aws::Structure
160
+ end
161
+
162
+ # @!attribute [rw] pipeline
163
+ # The service pipeline detail data that's returned by AWS Proton.
164
+ # @return [Types::ServicePipeline]
165
+ #
166
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServicePipelineDeploymentOutput AWS API Documentation
167
+ #
168
+ class CancelServicePipelineDeploymentOutput < Struct.new(
169
+ :pipeline)
170
+ SENSITIVE = []
171
+ include Aws::Structure
172
+ end
173
+
174
+ # Compatible environment template data.
175
+ #
176
+ # @!attribute [rw] major_version
177
+ # The major version of the compatible environment template.
178
+ # @return [String]
179
+ #
180
+ # @!attribute [rw] template_name
181
+ # The compatible environment template name.
182
+ # @return [String]
183
+ #
184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CompatibleEnvironmentTemplate AWS API Documentation
185
+ #
186
+ class CompatibleEnvironmentTemplate < Struct.new(
187
+ :major_version,
188
+ :template_name)
189
+ SENSITIVE = []
190
+ include Aws::Structure
191
+ end
192
+
193
+ # Compatible environment template data.
194
+ #
195
+ # @note When making an API call, you may pass CompatibleEnvironmentTemplateInput
196
+ # data as a hash:
197
+ #
198
+ # {
199
+ # major_version: "TemplateVersionPart", # required
200
+ # template_name: "ResourceName", # required
201
+ # }
202
+ #
203
+ # @!attribute [rw] major_version
204
+ # The major version of the compatible environment template.
205
+ # @return [String]
206
+ #
207
+ # @!attribute [rw] template_name
208
+ # The compatible environment template name.
209
+ # @return [String]
210
+ #
211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CompatibleEnvironmentTemplateInput AWS API Documentation
212
+ #
213
+ class CompatibleEnvironmentTemplateInput < Struct.new(
214
+ :major_version,
215
+ :template_name)
216
+ SENSITIVE = []
217
+ include Aws::Structure
218
+ end
219
+
220
+ # The request *couldn't* be made due to a conflicting operation or
221
+ # resource.
222
+ #
223
+ # @!attribute [rw] message
224
+ # @return [String]
225
+ #
226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ConflictException AWS API Documentation
227
+ #
228
+ class ConflictException < Struct.new(
229
+ :message)
230
+ SENSITIVE = [:message]
231
+ include Aws::Structure
232
+ end
233
+
234
+ # @note When making an API call, you may pass CreateEnvironmentAccountConnectionInput
235
+ # data as a hash:
236
+ #
237
+ # {
238
+ # client_token: "ClientToken",
239
+ # environment_name: "ResourceName", # required
240
+ # management_account_id: "AwsAccountId", # required
241
+ # role_arn: "Arn", # required
242
+ # }
243
+ #
244
+ # @!attribute [rw] client_token
245
+ # When included, if two identicial requests are made with the same
246
+ # client token, AWS Proton returns the environment account connection
247
+ # that the first request created.
248
+ #
249
+ # **A suitable default value is auto-generated.** You should normally
250
+ # not need to pass this option.
251
+ # @return [String]
252
+ #
253
+ # @!attribute [rw] environment_name
254
+ # The name of the AWS Proton environment that's created in the
255
+ # associated management account.
256
+ # @return [String]
257
+ #
258
+ # @!attribute [rw] management_account_id
259
+ # The ID of the management account that accepts or rejects the
260
+ # environment account connection. You create an manage the AWS Proton
261
+ # environment in this account. If the management account accepts the
262
+ # environment account connection, AWS Proton can use the associated
263
+ # IAM role to provision environment infrastructure resources in the
264
+ # associated environment account.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] role_arn
268
+ # The Amazon Resource Name (ARN) of the IAM service role that's
269
+ # created in the environment account. AWS Proton uses this role to
270
+ # provision infrastructure resources in the associated environment
271
+ # account.
272
+ # @return [String]
273
+ #
274
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentAccountConnectionInput AWS API Documentation
275
+ #
276
+ class CreateEnvironmentAccountConnectionInput < Struct.new(
277
+ :client_token,
278
+ :environment_name,
279
+ :management_account_id,
280
+ :role_arn)
281
+ SENSITIVE = []
282
+ include Aws::Structure
283
+ end
284
+
285
+ # @!attribute [rw] environment_account_connection
286
+ # The environment account connection detail data that's returned by
287
+ # AWS Proton.
288
+ # @return [Types::EnvironmentAccountConnection]
289
+ #
290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentAccountConnectionOutput AWS API Documentation
291
+ #
292
+ class CreateEnvironmentAccountConnectionOutput < Struct.new(
293
+ :environment_account_connection)
294
+ SENSITIVE = []
295
+ include Aws::Structure
296
+ end
297
+
298
+ # @note When making an API call, you may pass CreateEnvironmentInput
299
+ # data as a hash:
300
+ #
301
+ # {
302
+ # description: "Description",
303
+ # environment_account_connection_id: "EnvironmentAccountConnectionId",
304
+ # name: "ResourceName", # required
305
+ # proton_service_role_arn: "Arn",
306
+ # spec: "SpecContents", # required
307
+ # tags: [
308
+ # {
309
+ # key: "TagKey", # required
310
+ # value: "TagValue", # required
311
+ # },
312
+ # ],
313
+ # template_major_version: "TemplateVersionPart", # required
314
+ # template_minor_version: "TemplateVersionPart",
315
+ # template_name: "ResourceName", # required
316
+ # }
317
+ #
318
+ # @!attribute [rw] description
319
+ # A description of the environment that's being created and deployed.
320
+ # @return [String]
321
+ #
322
+ # @!attribute [rw] environment_account_connection_id
323
+ # The ID of the environment account connection that you provide if
324
+ # you're provisioning your environment infrastructure resources to an
325
+ # environment account. You must include either the
326
+ # `environmentAccountConnectionId` or `protonServiceRoleArn` parameter
327
+ # and value. For more information, see [Environment account
328
+ # connections](proton/latest/adminguide/ag-env-account-connections.html)
329
+ # in the *AWS Proton Administration guide*.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] name
333
+ # The name of the environment.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] proton_service_role_arn
337
+ # The Amazon Resource Name (ARN) of the AWS Proton service role that
338
+ # allows AWS Proton to make calls to other services on your behalf.
339
+ # You must include either the `environmentAccountConnectionId` or
340
+ # `protonServiceRoleArn` parameter and value.
341
+ # @return [String]
342
+ #
343
+ # @!attribute [rw] spec
344
+ # A link to a YAML formatted spec file that provides inputs as defined
345
+ # in the environment template bundle schema file. For more
346
+ # information, see [Environments][1] in the *AWS Proton Administration
347
+ # Guide*.
348
+ #
349
+ #
350
+ #
351
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-managing-environments.html
352
+ # @return [String]
353
+ #
354
+ # @!attribute [rw] tags
355
+ # Create tags for your environment. For more information, see *AWS
356
+ # Proton resources and tagging* in the [AWS Proton Administration
357
+ # Guide][1] or [AWS Proton User Guide][2].
358
+ #
359
+ #
360
+ #
361
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
362
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
363
+ # @return [Array<Types::Tag>]
364
+ #
365
+ # @!attribute [rw] template_major_version
366
+ # The ID of the major version of the environment template.
367
+ # @return [String]
368
+ #
369
+ # @!attribute [rw] template_minor_version
370
+ # The ID of the minor version of the environment template.
371
+ # @return [String]
372
+ #
373
+ # @!attribute [rw] template_name
374
+ # The name of the environment template. For more information, see
375
+ # [Environment Templates][1] in the *AWS Proton Administration Guide*.
376
+ #
377
+ #
378
+ #
379
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html
380
+ # @return [String]
381
+ #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentInput AWS API Documentation
383
+ #
384
+ class CreateEnvironmentInput < Struct.new(
385
+ :description,
386
+ :environment_account_connection_id,
387
+ :name,
388
+ :proton_service_role_arn,
389
+ :spec,
390
+ :tags,
391
+ :template_major_version,
392
+ :template_minor_version,
393
+ :template_name)
394
+ SENSITIVE = [:description, :spec]
395
+ include Aws::Structure
396
+ end
397
+
398
+ # @!attribute [rw] environment
399
+ # The environment detail data that's returned by AWS Proton.
400
+ # @return [Types::Environment]
401
+ #
402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentOutput AWS API Documentation
403
+ #
404
+ class CreateEnvironmentOutput < Struct.new(
405
+ :environment)
406
+ SENSITIVE = []
407
+ include Aws::Structure
408
+ end
409
+
410
+ # @note When making an API call, you may pass CreateEnvironmentTemplateInput
411
+ # data as a hash:
412
+ #
413
+ # {
414
+ # description: "Description",
415
+ # display_name: "DisplayName",
416
+ # encryption_key: "Arn",
417
+ # name: "ResourceName", # required
418
+ # provisioning: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED
419
+ # tags: [
420
+ # {
421
+ # key: "TagKey", # required
422
+ # value: "TagValue", # required
423
+ # },
424
+ # ],
425
+ # }
426
+ #
427
+ # @!attribute [rw] description
428
+ # A description of the environment template.
429
+ # @return [String]
430
+ #
431
+ # @!attribute [rw] display_name
432
+ # The environment template name as displayed in the developer
433
+ # interface.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] encryption_key
437
+ # A customer provided encryption key that AWS Proton uses to encrypt
438
+ # data.
439
+ # @return [String]
440
+ #
441
+ # @!attribute [rw] name
442
+ # The name of the environment template.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] provisioning
446
+ # When included, indicates that the environment template is for
447
+ # customer provisioned and managed infrastructure.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] tags
451
+ # Create tags for your environment template. For more information, see
452
+ # *AWS Proton resources and tagging* in the [AWS Proton Administration
453
+ # Guide][1] or [AWS Proton User Guide][2].
454
+ #
455
+ #
456
+ #
457
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
458
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
459
+ # @return [Array<Types::Tag>]
460
+ #
461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateInput AWS API Documentation
462
+ #
463
+ class CreateEnvironmentTemplateInput < Struct.new(
464
+ :description,
465
+ :display_name,
466
+ :encryption_key,
467
+ :name,
468
+ :provisioning,
469
+ :tags)
470
+ SENSITIVE = [:description, :display_name]
471
+ include Aws::Structure
472
+ end
473
+
474
+ # @!attribute [rw] environment_template
475
+ # The environment template detail data that's returned by AWS Proton.
476
+ # @return [Types::EnvironmentTemplate]
477
+ #
478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateOutput AWS API Documentation
479
+ #
480
+ class CreateEnvironmentTemplateOutput < Struct.new(
481
+ :environment_template)
482
+ SENSITIVE = []
483
+ include Aws::Structure
484
+ end
485
+
486
+ # @note When making an API call, you may pass CreateEnvironmentTemplateVersionInput
487
+ # data as a hash:
488
+ #
489
+ # {
490
+ # client_token: "ClientToken",
491
+ # description: "Description",
492
+ # major_version: "TemplateVersionPart",
493
+ # source: { # required
494
+ # s3: {
495
+ # bucket: "S3Bucket", # required
496
+ # key: "S3Key", # required
497
+ # },
498
+ # },
499
+ # tags: [
500
+ # {
501
+ # key: "TagKey", # required
502
+ # value: "TagValue", # required
503
+ # },
504
+ # ],
505
+ # template_name: "ResourceName", # required
506
+ # }
507
+ #
508
+ # @!attribute [rw] client_token
509
+ # When included, if two identicial requests are made with the same
510
+ # client token, AWS Proton returns the environment template version
511
+ # that the first request created.
512
+ #
513
+ # **A suitable default value is auto-generated.** You should normally
514
+ # not need to pass this option.
515
+ # @return [String]
516
+ #
517
+ # @!attribute [rw] description
518
+ # A description of the new version of an environment template.
519
+ # @return [String]
520
+ #
521
+ # @!attribute [rw] major_version
522
+ # To create a new minor version of the environment template, include a
523
+ # `majorVersion`.
524
+ #
525
+ # To create a new major and minor version of the environment template,
526
+ # exclude `majorVersion`.
527
+ # @return [String]
528
+ #
529
+ # @!attribute [rw] source
530
+ # An object that includes the template bundle S3 bucket path and name
531
+ # for the new version of an template.
532
+ # @return [Types::TemplateVersionSourceInput]
533
+ #
534
+ # @!attribute [rw] tags
535
+ # Create tags for a new version of an environment template.
536
+ # @return [Array<Types::Tag>]
537
+ #
538
+ # @!attribute [rw] template_name
539
+ # The name of the environment template.
540
+ # @return [String]
541
+ #
542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateVersionInput AWS API Documentation
543
+ #
544
+ class CreateEnvironmentTemplateVersionInput < Struct.new(
545
+ :client_token,
546
+ :description,
547
+ :major_version,
548
+ :source,
549
+ :tags,
550
+ :template_name)
551
+ SENSITIVE = [:description]
552
+ include Aws::Structure
553
+ end
554
+
555
+ # @!attribute [rw] environment_template_version
556
+ # The environment template detail data that's returned by AWS Proton.
557
+ # @return [Types::EnvironmentTemplateVersion]
558
+ #
559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateVersionOutput AWS API Documentation
560
+ #
561
+ class CreateEnvironmentTemplateVersionOutput < Struct.new(
562
+ :environment_template_version)
563
+ SENSITIVE = []
564
+ include Aws::Structure
565
+ end
566
+
567
+ # @note When making an API call, you may pass CreateServiceInput
568
+ # data as a hash:
569
+ #
570
+ # {
571
+ # branch_name: "GitBranchName",
572
+ # description: "Description",
573
+ # name: "ResourceName", # required
574
+ # repository_connection_arn: "Arn",
575
+ # repository_id: "RepositoryId",
576
+ # spec: "SpecContents", # required
577
+ # tags: [
578
+ # {
579
+ # key: "TagKey", # required
580
+ # value: "TagValue", # required
581
+ # },
582
+ # ],
583
+ # template_major_version: "TemplateVersionPart", # required
584
+ # template_minor_version: "TemplateVersionPart",
585
+ # template_name: "ResourceName", # required
586
+ # }
587
+ #
588
+ # @!attribute [rw] branch_name
589
+ # The name of the code repository branch that holds the code that's
590
+ # deployed in AWS Proton. *Don't* include this parameter if your
591
+ # service template *doesn't* include a service pipeline.
592
+ # @return [String]
593
+ #
594
+ # @!attribute [rw] description
595
+ # A description of the AWS Proton service.
596
+ # @return [String]
597
+ #
598
+ # @!attribute [rw] name
599
+ # The service name.
600
+ # @return [String]
601
+ #
602
+ # @!attribute [rw] repository_connection_arn
603
+ # The ARN of the repository connection. For more information, see [Set
604
+ # up repository connection][1] in the *AWS Proton Administration
605
+ # Guide* and [Getting started][2] in the *AWS Proton User Guide*.
606
+ # *Don't* include this parameter if your service template *doesn't*
607
+ # include a service pipeline.
608
+ #
609
+ #
610
+ #
611
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#settingSS-up-vcontrol
612
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-getting-started.html#getting-started-step1
613
+ # @return [String]
614
+ #
615
+ # @!attribute [rw] repository_id
616
+ # The ID of the code repository. *Don't* include this parameter if
617
+ # your service template *doesn't* include a service pipeline.
618
+ # @return [String]
619
+ #
620
+ # @!attribute [rw] spec
621
+ # A link to a spec file that provides inputs as defined in the service
622
+ # template bundle schema file. The spec file is in YAML format. Don’t
623
+ # include pipeline inputs in the spec if your service template doesn’t
624
+ # include a service pipeline. For more information, see [Create a
625
+ # service][1] in the *AWS Proton Administration Guide* and [Create a
626
+ # service][2] in the *AWS Proton User Guide*.
627
+ #
628
+ #
629
+ #
630
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html.html
631
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html
632
+ # @return [String]
633
+ #
634
+ # @!attribute [rw] tags
635
+ # Create tags for your service. For more information, see *AWS Proton
636
+ # resources and tagging* in the [AWS Proton Administration Guide][1]
637
+ # or [AWS Proton User Guide][2].
638
+ #
639
+ #
640
+ #
641
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
642
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
643
+ # @return [Array<Types::Tag>]
644
+ #
645
+ # @!attribute [rw] template_major_version
646
+ # The ID of the major version of the service template that was used to
647
+ # create the service.
648
+ # @return [String]
649
+ #
650
+ # @!attribute [rw] template_minor_version
651
+ # The ID of the minor version of the service template that was used to
652
+ # create the service.
653
+ # @return [String]
654
+ #
655
+ # @!attribute [rw] template_name
656
+ # The name of the service template that's used to create the service.
657
+ # @return [String]
658
+ #
659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceInput AWS API Documentation
660
+ #
661
+ class CreateServiceInput < Struct.new(
662
+ :branch_name,
663
+ :description,
664
+ :name,
665
+ :repository_connection_arn,
666
+ :repository_id,
667
+ :spec,
668
+ :tags,
669
+ :template_major_version,
670
+ :template_minor_version,
671
+ :template_name)
672
+ SENSITIVE = [:description, :spec]
673
+ include Aws::Structure
674
+ end
675
+
676
+ # @!attribute [rw] service
677
+ # The service detail data that's returned by AWS Proton.
678
+ # @return [Types::Service]
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceOutput AWS API Documentation
681
+ #
682
+ class CreateServiceOutput < Struct.new(
683
+ :service)
684
+ SENSITIVE = []
685
+ include Aws::Structure
686
+ end
687
+
688
+ # @note When making an API call, you may pass CreateServiceTemplateInput
689
+ # data as a hash:
690
+ #
691
+ # {
692
+ # description: "Description",
693
+ # display_name: "DisplayName",
694
+ # encryption_key: "Arn",
695
+ # name: "ResourceName", # required
696
+ # pipeline_provisioning: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED
697
+ # tags: [
698
+ # {
699
+ # key: "TagKey", # required
700
+ # value: "TagValue", # required
701
+ # },
702
+ # ],
703
+ # }
704
+ #
705
+ # @!attribute [rw] description
706
+ # A description of the service template.
707
+ # @return [String]
708
+ #
709
+ # @!attribute [rw] display_name
710
+ # The name of the service template as displayed in the developer
711
+ # interface.
712
+ # @return [String]
713
+ #
714
+ # @!attribute [rw] encryption_key
715
+ # A customer provided encryption key that's used to encrypt data.
716
+ # @return [String]
717
+ #
718
+ # @!attribute [rw] name
719
+ # The name of the service template.
720
+ # @return [String]
721
+ #
722
+ # @!attribute [rw] pipeline_provisioning
723
+ # AWS Proton includes a service pipeline for your service by default.
724
+ # When included, this parameter indicates that an AWS Proton service
725
+ # pipeline *won't* be included for your service. Once specified, this
726
+ # parameter *can't* be changed. For more information, see [Service
727
+ # template bundles][1] in the *AWS Proton Administration Guide*.
728
+ #
729
+ #
730
+ #
731
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-template-bundles.html
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] tags
735
+ # Create tags for your service template. For more information, see
736
+ # *AWS Proton resources and tagging* in the [AWS Proton Administration
737
+ # Guide][1] or [AWS Proton User Guide][2].
738
+ #
739
+ #
740
+ #
741
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
742
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
743
+ # @return [Array<Types::Tag>]
744
+ #
745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateInput AWS API Documentation
746
+ #
747
+ class CreateServiceTemplateInput < Struct.new(
748
+ :description,
749
+ :display_name,
750
+ :encryption_key,
751
+ :name,
752
+ :pipeline_provisioning,
753
+ :tags)
754
+ SENSITIVE = [:description, :display_name]
755
+ include Aws::Structure
756
+ end
757
+
758
+ # @!attribute [rw] service_template
759
+ # The service template detail data that's returned by AWS Proton.
760
+ # @return [Types::ServiceTemplate]
761
+ #
762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateOutput AWS API Documentation
763
+ #
764
+ class CreateServiceTemplateOutput < Struct.new(
765
+ :service_template)
766
+ SENSITIVE = []
767
+ include Aws::Structure
768
+ end
769
+
770
+ # @note When making an API call, you may pass CreateServiceTemplateVersionInput
771
+ # data as a hash:
772
+ #
773
+ # {
774
+ # client_token: "ClientToken",
775
+ # compatible_environment_templates: [ # required
776
+ # {
777
+ # major_version: "TemplateVersionPart", # required
778
+ # template_name: "ResourceName", # required
779
+ # },
780
+ # ],
781
+ # description: "Description",
782
+ # major_version: "TemplateVersionPart",
783
+ # source: { # required
784
+ # s3: {
785
+ # bucket: "S3Bucket", # required
786
+ # key: "S3Key", # required
787
+ # },
788
+ # },
789
+ # tags: [
790
+ # {
791
+ # key: "TagKey", # required
792
+ # value: "TagValue", # required
793
+ # },
794
+ # ],
795
+ # template_name: "ResourceName", # required
796
+ # }
797
+ #
798
+ # @!attribute [rw] client_token
799
+ # When included, if two identicial requests are made with the same
800
+ # client token, AWS Proton returns the service template version that
801
+ # the first request created.
802
+ #
803
+ # **A suitable default value is auto-generated.** You should normally
804
+ # not need to pass this option.
805
+ # @return [String]
806
+ #
807
+ # @!attribute [rw] compatible_environment_templates
808
+ # An array of compatible environment template objects for the new
809
+ # version of a service template.
810
+ # @return [Array<Types::CompatibleEnvironmentTemplateInput>]
811
+ #
812
+ # @!attribute [rw] description
813
+ # A description of the new version of a service template.
814
+ # @return [String]
815
+ #
816
+ # @!attribute [rw] major_version
817
+ # To create a new minor version of the service template, include a
818
+ # `majorVersion`.
819
+ #
820
+ # To create a new major and minor version of the service template,
821
+ # *exclude* `majorVersion`.
822
+ # @return [String]
823
+ #
824
+ # @!attribute [rw] source
825
+ # An object that includes the template bundle S3 bucket path and name
826
+ # for the new version of a service template.
827
+ # @return [Types::TemplateVersionSourceInput]
828
+ #
829
+ # @!attribute [rw] tags
830
+ # Create tags for a new version of a service template.
831
+ # @return [Array<Types::Tag>]
832
+ #
833
+ # @!attribute [rw] template_name
834
+ # The name of the service template.
835
+ # @return [String]
836
+ #
837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersionInput AWS API Documentation
838
+ #
839
+ class CreateServiceTemplateVersionInput < Struct.new(
840
+ :client_token,
841
+ :compatible_environment_templates,
842
+ :description,
843
+ :major_version,
844
+ :source,
845
+ :tags,
846
+ :template_name)
847
+ SENSITIVE = [:description]
848
+ include Aws::Structure
849
+ end
850
+
851
+ # @!attribute [rw] service_template_version
852
+ # The service template version summary of detail data that's returned
853
+ # by AWS Proton.
854
+ # @return [Types::ServiceTemplateVersion]
855
+ #
856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersionOutput AWS API Documentation
857
+ #
858
+ class CreateServiceTemplateVersionOutput < Struct.new(
859
+ :service_template_version)
860
+ SENSITIVE = []
861
+ include Aws::Structure
862
+ end
863
+
864
+ # @note When making an API call, you may pass DeleteEnvironmentAccountConnectionInput
865
+ # data as a hash:
866
+ #
867
+ # {
868
+ # id: "EnvironmentAccountConnectionId", # required
869
+ # }
870
+ #
871
+ # @!attribute [rw] id
872
+ # The ID of the environment account connection to delete.
873
+ # @return [String]
874
+ #
875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentAccountConnectionInput AWS API Documentation
876
+ #
877
+ class DeleteEnvironmentAccountConnectionInput < Struct.new(
878
+ :id)
879
+ SENSITIVE = []
880
+ include Aws::Structure
881
+ end
882
+
883
+ # @!attribute [rw] environment_account_connection
884
+ # The environment account connection detail data that's returned by
885
+ # AWS Proton.
886
+ # @return [Types::EnvironmentAccountConnection]
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentAccountConnectionOutput AWS API Documentation
889
+ #
890
+ class DeleteEnvironmentAccountConnectionOutput < Struct.new(
891
+ :environment_account_connection)
892
+ SENSITIVE = []
893
+ include Aws::Structure
894
+ end
895
+
896
+ # @note When making an API call, you may pass DeleteEnvironmentInput
897
+ # data as a hash:
898
+ #
899
+ # {
900
+ # name: "ResourceName", # required
901
+ # }
902
+ #
903
+ # @!attribute [rw] name
904
+ # The name of the environment to delete.
905
+ # @return [String]
906
+ #
907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentInput AWS API Documentation
908
+ #
909
+ class DeleteEnvironmentInput < Struct.new(
910
+ :name)
911
+ SENSITIVE = []
912
+ include Aws::Structure
913
+ end
914
+
915
+ # @!attribute [rw] environment
916
+ # The environment detail data that's returned by AWS Proton.
917
+ # @return [Types::Environment]
918
+ #
919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentOutput AWS API Documentation
920
+ #
921
+ class DeleteEnvironmentOutput < Struct.new(
922
+ :environment)
923
+ SENSITIVE = []
924
+ include Aws::Structure
925
+ end
926
+
927
+ # @note When making an API call, you may pass DeleteEnvironmentTemplateInput
928
+ # data as a hash:
929
+ #
930
+ # {
931
+ # name: "ResourceName", # required
932
+ # }
933
+ #
934
+ # @!attribute [rw] name
935
+ # The name of the environment template to delete.
936
+ # @return [String]
937
+ #
938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateInput AWS API Documentation
939
+ #
940
+ class DeleteEnvironmentTemplateInput < Struct.new(
941
+ :name)
942
+ SENSITIVE = []
943
+ include Aws::Structure
944
+ end
945
+
946
+ # @!attribute [rw] environment_template
947
+ # The environment template detail data that's returned by AWS Proton.
948
+ # @return [Types::EnvironmentTemplate]
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateOutput AWS API Documentation
951
+ #
952
+ class DeleteEnvironmentTemplateOutput < Struct.new(
953
+ :environment_template)
954
+ SENSITIVE = []
955
+ include Aws::Structure
956
+ end
957
+
958
+ # @note When making an API call, you may pass DeleteEnvironmentTemplateVersionInput
959
+ # data as a hash:
960
+ #
961
+ # {
962
+ # major_version: "TemplateVersionPart", # required
963
+ # minor_version: "TemplateVersionPart", # required
964
+ # template_name: "ResourceName", # required
965
+ # }
966
+ #
967
+ # @!attribute [rw] major_version
968
+ # The environment template major version to delete.
969
+ # @return [String]
970
+ #
971
+ # @!attribute [rw] minor_version
972
+ # The environment template minor version to delete.
973
+ # @return [String]
974
+ #
975
+ # @!attribute [rw] template_name
976
+ # The name of the environment template.
977
+ # @return [String]
978
+ #
979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateVersionInput AWS API Documentation
980
+ #
981
+ class DeleteEnvironmentTemplateVersionInput < Struct.new(
982
+ :major_version,
983
+ :minor_version,
984
+ :template_name)
985
+ SENSITIVE = []
986
+ include Aws::Structure
987
+ end
988
+
989
+ # @!attribute [rw] environment_template_version
990
+ # The environment template version detail data that's returned by AWS
991
+ # Proton.
992
+ # @return [Types::EnvironmentTemplateVersion]
993
+ #
994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateVersionOutput AWS API Documentation
995
+ #
996
+ class DeleteEnvironmentTemplateVersionOutput < Struct.new(
997
+ :environment_template_version)
998
+ SENSITIVE = []
999
+ include Aws::Structure
1000
+ end
1001
+
1002
+ # @note When making an API call, you may pass DeleteServiceInput
1003
+ # data as a hash:
1004
+ #
1005
+ # {
1006
+ # name: "ResourceName", # required
1007
+ # }
1008
+ #
1009
+ # @!attribute [rw] name
1010
+ # The name of the service to delete.
1011
+ # @return [String]
1012
+ #
1013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceInput AWS API Documentation
1014
+ #
1015
+ class DeleteServiceInput < Struct.new(
1016
+ :name)
1017
+ SENSITIVE = []
1018
+ include Aws::Structure
1019
+ end
1020
+
1021
+ # @!attribute [rw] service
1022
+ # The service detail data that's returned by AWS Proton.
1023
+ # @return [Types::Service]
1024
+ #
1025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceOutput AWS API Documentation
1026
+ #
1027
+ class DeleteServiceOutput < Struct.new(
1028
+ :service)
1029
+ SENSITIVE = []
1030
+ include Aws::Structure
1031
+ end
1032
+
1033
+ # @note When making an API call, you may pass DeleteServiceTemplateInput
1034
+ # data as a hash:
1035
+ #
1036
+ # {
1037
+ # name: "ResourceName", # required
1038
+ # }
1039
+ #
1040
+ # @!attribute [rw] name
1041
+ # The name of the service template to delete.
1042
+ # @return [String]
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateInput AWS API Documentation
1045
+ #
1046
+ class DeleteServiceTemplateInput < Struct.new(
1047
+ :name)
1048
+ SENSITIVE = []
1049
+ include Aws::Structure
1050
+ end
1051
+
1052
+ # @!attribute [rw] service_template
1053
+ # The service template detail data that's returned by AWS Proton.
1054
+ # @return [Types::ServiceTemplate]
1055
+ #
1056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateOutput AWS API Documentation
1057
+ #
1058
+ class DeleteServiceTemplateOutput < Struct.new(
1059
+ :service_template)
1060
+ SENSITIVE = []
1061
+ include Aws::Structure
1062
+ end
1063
+
1064
+ # @note When making an API call, you may pass DeleteServiceTemplateVersionInput
1065
+ # data as a hash:
1066
+ #
1067
+ # {
1068
+ # major_version: "TemplateVersionPart", # required
1069
+ # minor_version: "TemplateVersionPart", # required
1070
+ # template_name: "ResourceName", # required
1071
+ # }
1072
+ #
1073
+ # @!attribute [rw] major_version
1074
+ # The service template major version to delete.
1075
+ # @return [String]
1076
+ #
1077
+ # @!attribute [rw] minor_version
1078
+ # The service template minor version to delete.
1079
+ # @return [String]
1080
+ #
1081
+ # @!attribute [rw] template_name
1082
+ # The name of the service template.
1083
+ # @return [String]
1084
+ #
1085
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersionInput AWS API Documentation
1086
+ #
1087
+ class DeleteServiceTemplateVersionInput < Struct.new(
1088
+ :major_version,
1089
+ :minor_version,
1090
+ :template_name)
1091
+ SENSITIVE = []
1092
+ include Aws::Structure
1093
+ end
1094
+
1095
+ # @!attribute [rw] service_template_version
1096
+ # The service template version detail data that's returned by AWS
1097
+ # Proton.
1098
+ # @return [Types::ServiceTemplateVersion]
1099
+ #
1100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersionOutput AWS API Documentation
1101
+ #
1102
+ class DeleteServiceTemplateVersionOutput < Struct.new(
1103
+ :service_template_version)
1104
+ SENSITIVE = []
1105
+ include Aws::Structure
1106
+ end
1107
+
1108
+ # The environment detail data. An AWS Proton environment is a set
1109
+ # resources shared across an AWS Proton service.
1110
+ #
1111
+ # @!attribute [rw] arn
1112
+ # The Amazon Resource Name (ARN) of the environment.
1113
+ # @return [String]
1114
+ #
1115
+ # @!attribute [rw] created_at
1116
+ # The time when the environment was created.
1117
+ # @return [Time]
1118
+ #
1119
+ # @!attribute [rw] deployment_status
1120
+ # The environment deployment status.
1121
+ # @return [String]
1122
+ #
1123
+ # @!attribute [rw] deployment_status_message
1124
+ # An environment deployment status message.
1125
+ # @return [String]
1126
+ #
1127
+ # @!attribute [rw] description
1128
+ # The description of the environment.
1129
+ # @return [String]
1130
+ #
1131
+ # @!attribute [rw] environment_account_connection_id
1132
+ # The ID of the environment account connection that's used to
1133
+ # provision infrastructure resources in an environment account.
1134
+ # @return [String]
1135
+ #
1136
+ # @!attribute [rw] environment_account_id
1137
+ # The ID of the environment account that the environment
1138
+ # infrastructure resources are provisioned in.
1139
+ # @return [String]
1140
+ #
1141
+ # @!attribute [rw] last_deployment_attempted_at
1142
+ # The time when a deployment of the environment was last attempted.
1143
+ # @return [Time]
1144
+ #
1145
+ # @!attribute [rw] last_deployment_succeeded_at
1146
+ # The time when the environment was last deployed successfully.
1147
+ # @return [Time]
1148
+ #
1149
+ # @!attribute [rw] name
1150
+ # The name of the environment.
1151
+ # @return [String]
1152
+ #
1153
+ # @!attribute [rw] proton_service_role_arn
1154
+ # The ARN of the AWS Proton service role that allows AWS Proton to
1155
+ # make calls to other services on your behalf.
1156
+ # @return [String]
1157
+ #
1158
+ # @!attribute [rw] provisioning
1159
+ # When included, indicates that the environment template is for
1160
+ # customer provisioned and managed infrastructure.
1161
+ # @return [String]
1162
+ #
1163
+ # @!attribute [rw] spec
1164
+ # The environment spec.
1165
+ # @return [String]
1166
+ #
1167
+ # @!attribute [rw] template_major_version
1168
+ # The ID of the major version of the environment template.
1169
+ # @return [String]
1170
+ #
1171
+ # @!attribute [rw] template_minor_version
1172
+ # The ID of the minor version of the environment template.
1173
+ # @return [String]
1174
+ #
1175
+ # @!attribute [rw] template_name
1176
+ # The ARN of the environment template.
1177
+ # @return [String]
1178
+ #
1179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Environment AWS API Documentation
1180
+ #
1181
+ class Environment < Struct.new(
1182
+ :arn,
1183
+ :created_at,
1184
+ :deployment_status,
1185
+ :deployment_status_message,
1186
+ :description,
1187
+ :environment_account_connection_id,
1188
+ :environment_account_id,
1189
+ :last_deployment_attempted_at,
1190
+ :last_deployment_succeeded_at,
1191
+ :name,
1192
+ :proton_service_role_arn,
1193
+ :provisioning,
1194
+ :spec,
1195
+ :template_major_version,
1196
+ :template_minor_version,
1197
+ :template_name)
1198
+ SENSITIVE = [:deployment_status_message, :description, :spec]
1199
+ include Aws::Structure
1200
+ end
1201
+
1202
+ # The environment account connection detail data.
1203
+ #
1204
+ # @!attribute [rw] arn
1205
+ # The Amazon Resource Name (ARN) of the environment account
1206
+ # connection.
1207
+ # @return [String]
1208
+ #
1209
+ # @!attribute [rw] environment_account_id
1210
+ # The environment account that's connected to the environment account
1211
+ # connection.
1212
+ # @return [String]
1213
+ #
1214
+ # @!attribute [rw] environment_name
1215
+ # The name of the environment that's associated with the environment
1216
+ # account connection.
1217
+ # @return [String]
1218
+ #
1219
+ # @!attribute [rw] id
1220
+ # The ID of the environment account connection.
1221
+ # @return [String]
1222
+ #
1223
+ # @!attribute [rw] last_modified_at
1224
+ # The time when the environment account connection was last modified.
1225
+ # @return [Time]
1226
+ #
1227
+ # @!attribute [rw] management_account_id
1228
+ # The ID of the management account that's connected to the
1229
+ # environment account connection.
1230
+ # @return [String]
1231
+ #
1232
+ # @!attribute [rw] requested_at
1233
+ # The time when the environment account connection request was made.
1234
+ # @return [Time]
1235
+ #
1236
+ # @!attribute [rw] role_arn
1237
+ # The IAM service role that's associated with the environment account
1238
+ # connection.
1239
+ # @return [String]
1240
+ #
1241
+ # @!attribute [rw] status
1242
+ # The status of the environment account connection.
1243
+ # @return [String]
1244
+ #
1245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentAccountConnection AWS API Documentation
1246
+ #
1247
+ class EnvironmentAccountConnection < Struct.new(
1248
+ :arn,
1249
+ :environment_account_id,
1250
+ :environment_name,
1251
+ :id,
1252
+ :last_modified_at,
1253
+ :management_account_id,
1254
+ :requested_at,
1255
+ :role_arn,
1256
+ :status)
1257
+ SENSITIVE = []
1258
+ include Aws::Structure
1259
+ end
1260
+
1261
+ # A summary of the environment account connection detail data.
1262
+ #
1263
+ # @!attribute [rw] arn
1264
+ # The Amazon Resource Name (ARN) of the environment account
1265
+ # connection.
1266
+ # @return [String]
1267
+ #
1268
+ # @!attribute [rw] environment_account_id
1269
+ # The ID of the environment account that's connected to the
1270
+ # environment account connection.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] environment_name
1274
+ # The name of the environment that's associated with the environment
1275
+ # account connection.
1276
+ # @return [String]
1277
+ #
1278
+ # @!attribute [rw] id
1279
+ # The ID of the environment account connection.
1280
+ # @return [String]
1281
+ #
1282
+ # @!attribute [rw] last_modified_at
1283
+ # The time when the environment account connection was last modified.
1284
+ # @return [Time]
1285
+ #
1286
+ # @!attribute [rw] management_account_id
1287
+ # The ID of the management account that's connected to the
1288
+ # environment account connection.
1289
+ # @return [String]
1290
+ #
1291
+ # @!attribute [rw] requested_at
1292
+ # The time when the environment account connection request was made.
1293
+ # @return [Time]
1294
+ #
1295
+ # @!attribute [rw] role_arn
1296
+ # The IAM service role that's associated with the environment account
1297
+ # connection.
1298
+ # @return [String]
1299
+ #
1300
+ # @!attribute [rw] status
1301
+ # The status of the environment account connection.
1302
+ # @return [String]
1303
+ #
1304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentAccountConnectionSummary AWS API Documentation
1305
+ #
1306
+ class EnvironmentAccountConnectionSummary < Struct.new(
1307
+ :arn,
1308
+ :environment_account_id,
1309
+ :environment_name,
1310
+ :id,
1311
+ :last_modified_at,
1312
+ :management_account_id,
1313
+ :requested_at,
1314
+ :role_arn,
1315
+ :status)
1316
+ SENSITIVE = []
1317
+ include Aws::Structure
1318
+ end
1319
+
1320
+ # A summary of the environment detail data.
1321
+ #
1322
+ # @!attribute [rw] arn
1323
+ # The Amazon Resource Name (ARN) of the environment.
1324
+ # @return [String]
1325
+ #
1326
+ # @!attribute [rw] created_at
1327
+ # The time when the environment was created.
1328
+ # @return [Time]
1329
+ #
1330
+ # @!attribute [rw] deployment_status
1331
+ # The environment deployment status.
1332
+ # @return [String]
1333
+ #
1334
+ # @!attribute [rw] deployment_status_message
1335
+ # An environment deployment status message.
1336
+ # @return [String]
1337
+ #
1338
+ # @!attribute [rw] description
1339
+ # The description of the environment.
1340
+ # @return [String]
1341
+ #
1342
+ # @!attribute [rw] environment_account_connection_id
1343
+ # The ID of the environment account connection that the environment is
1344
+ # associated with.
1345
+ # @return [String]
1346
+ #
1347
+ # @!attribute [rw] environment_account_id
1348
+ # The ID of the environment account that the environment
1349
+ # infrastructure resources are provisioned in.
1350
+ # @return [String]
1351
+ #
1352
+ # @!attribute [rw] last_deployment_attempted_at
1353
+ # The time when a deployment of the environment was last attempted.
1354
+ # @return [Time]
1355
+ #
1356
+ # @!attribute [rw] last_deployment_succeeded_at
1357
+ # The time when the environment was last deployed successfully.
1358
+ # @return [Time]
1359
+ #
1360
+ # @!attribute [rw] name
1361
+ # The name of the environment.
1362
+ # @return [String]
1363
+ #
1364
+ # @!attribute [rw] proton_service_role_arn
1365
+ # The ARN of the AWS Proton service role that allows AWS Proton to
1366
+ # make calls to other services on your behalf.
1367
+ # @return [String]
1368
+ #
1369
+ # @!attribute [rw] provisioning
1370
+ # When included, indicates that the environment template is for
1371
+ # customer provisioned and managed infrastructure.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] template_major_version
1375
+ # The ID of the major version of the environment template.
1376
+ # @return [String]
1377
+ #
1378
+ # @!attribute [rw] template_minor_version
1379
+ # The ID of the minor version of the environment template.
1380
+ # @return [String]
1381
+ #
1382
+ # @!attribute [rw] template_name
1383
+ # The name of the environment template.
1384
+ # @return [String]
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentSummary AWS API Documentation
1387
+ #
1388
+ class EnvironmentSummary < Struct.new(
1389
+ :arn,
1390
+ :created_at,
1391
+ :deployment_status,
1392
+ :deployment_status_message,
1393
+ :description,
1394
+ :environment_account_connection_id,
1395
+ :environment_account_id,
1396
+ :last_deployment_attempted_at,
1397
+ :last_deployment_succeeded_at,
1398
+ :name,
1399
+ :proton_service_role_arn,
1400
+ :provisioning,
1401
+ :template_major_version,
1402
+ :template_minor_version,
1403
+ :template_name)
1404
+ SENSITIVE = [:deployment_status_message, :description]
1405
+ include Aws::Structure
1406
+ end
1407
+
1408
+ # The environment template data.
1409
+ #
1410
+ # @!attribute [rw] arn
1411
+ # The Amazon Resource Name (ARN) of the environment template.
1412
+ # @return [String]
1413
+ #
1414
+ # @!attribute [rw] created_at
1415
+ # The time when the environment template was created.
1416
+ # @return [Time]
1417
+ #
1418
+ # @!attribute [rw] description
1419
+ # A description of the environment template.
1420
+ # @return [String]
1421
+ #
1422
+ # @!attribute [rw] display_name
1423
+ # The name of the environment template as displayed in the developer
1424
+ # interface.
1425
+ # @return [String]
1426
+ #
1427
+ # @!attribute [rw] encryption_key
1428
+ # The customer provided encryption key for the environment template.
1429
+ # @return [String]
1430
+ #
1431
+ # @!attribute [rw] last_modified_at
1432
+ # The time when the environment template was last modified.
1433
+ # @return [Time]
1434
+ #
1435
+ # @!attribute [rw] name
1436
+ # The name of the environment template.
1437
+ # @return [String]
1438
+ #
1439
+ # @!attribute [rw] provisioning
1440
+ # When included, indicates that the environment template is for
1441
+ # customer provisioned and managed infrastructure.
1442
+ # @return [String]
1443
+ #
1444
+ # @!attribute [rw] recommended_version
1445
+ # The ID of the recommended version of the environment template.
1446
+ # @return [String]
1447
+ #
1448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplate AWS API Documentation
1449
+ #
1450
+ class EnvironmentTemplate < Struct.new(
1451
+ :arn,
1452
+ :created_at,
1453
+ :description,
1454
+ :display_name,
1455
+ :encryption_key,
1456
+ :last_modified_at,
1457
+ :name,
1458
+ :provisioning,
1459
+ :recommended_version)
1460
+ SENSITIVE = [:description, :display_name]
1461
+ include Aws::Structure
1462
+ end
1463
+
1464
+ # A search filter for environment templates.
1465
+ #
1466
+ # @note When making an API call, you may pass EnvironmentTemplateFilter
1467
+ # data as a hash:
1468
+ #
1469
+ # {
1470
+ # major_version: "TemplateVersionPart", # required
1471
+ # template_name: "ResourceName", # required
1472
+ # }
1473
+ #
1474
+ # @!attribute [rw] major_version
1475
+ # Include `majorVersion` to filter search for a major version.
1476
+ # @return [String]
1477
+ #
1478
+ # @!attribute [rw] template_name
1479
+ # Include `templateName` to filter search for a template name.
1480
+ # @return [String]
1481
+ #
1482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateFilter AWS API Documentation
1483
+ #
1484
+ class EnvironmentTemplateFilter < Struct.new(
1485
+ :major_version,
1486
+ :template_name)
1487
+ SENSITIVE = []
1488
+ include Aws::Structure
1489
+ end
1490
+
1491
+ # The environment template data.
1492
+ #
1493
+ # @!attribute [rw] arn
1494
+ # The Amazon Resource Name (ARN) of the environment template.
1495
+ # @return [String]
1496
+ #
1497
+ # @!attribute [rw] created_at
1498
+ # The time when the environment template was created.
1499
+ # @return [Time]
1500
+ #
1501
+ # @!attribute [rw] description
1502
+ # A description of the environment template.
1503
+ # @return [String]
1504
+ #
1505
+ # @!attribute [rw] display_name
1506
+ # The name of the environment template as displayed in the developer
1507
+ # interface.
1508
+ # @return [String]
1509
+ #
1510
+ # @!attribute [rw] last_modified_at
1511
+ # The time when the environment template was last modified.
1512
+ # @return [Time]
1513
+ #
1514
+ # @!attribute [rw] name
1515
+ # The name of the environment template.
1516
+ # @return [String]
1517
+ #
1518
+ # @!attribute [rw] provisioning
1519
+ # When included, indicates that the environment template is for
1520
+ # customer provisioned and managed infrastructure.
1521
+ # @return [String]
1522
+ #
1523
+ # @!attribute [rw] recommended_version
1524
+ # The ID of the recommended version of the environment template.
1525
+ # @return [String]
1526
+ #
1527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateSummary AWS API Documentation
1528
+ #
1529
+ class EnvironmentTemplateSummary < Struct.new(
1530
+ :arn,
1531
+ :created_at,
1532
+ :description,
1533
+ :display_name,
1534
+ :last_modified_at,
1535
+ :name,
1536
+ :provisioning,
1537
+ :recommended_version)
1538
+ SENSITIVE = [:description, :display_name]
1539
+ include Aws::Structure
1540
+ end
1541
+
1542
+ # The environment template version data.
1543
+ #
1544
+ # @!attribute [rw] arn
1545
+ # The Amazon Resource Name (ARN) of the version of an environment
1546
+ # template.
1547
+ # @return [String]
1548
+ #
1549
+ # @!attribute [rw] created_at
1550
+ # The time when the version of an environment template was created.
1551
+ # @return [Time]
1552
+ #
1553
+ # @!attribute [rw] description
1554
+ # A description of the minor version of an environment template.
1555
+ # @return [String]
1556
+ #
1557
+ # @!attribute [rw] last_modified_at
1558
+ # The time when the version of an environment template was last
1559
+ # modified.
1560
+ # @return [Time]
1561
+ #
1562
+ # @!attribute [rw] major_version
1563
+ # The ID of the latest major version that's associated with the
1564
+ # version of an environment template.
1565
+ # @return [String]
1566
+ #
1567
+ # @!attribute [rw] minor_version
1568
+ # The ID of the minor version of an environment template.
1569
+ # @return [String]
1570
+ #
1571
+ # @!attribute [rw] recommended_minor_version
1572
+ # The ID of the recommended minor version of the environment template.
1573
+ # @return [String]
1574
+ #
1575
+ # @!attribute [rw] schema
1576
+ # The schema of the version of an environment template.
1577
+ # @return [String]
1578
+ #
1579
+ # @!attribute [rw] status
1580
+ # The status of the version of an environment template.
1581
+ # @return [String]
1582
+ #
1583
+ # @!attribute [rw] status_message
1584
+ # The status message of the version of an environment template.
1585
+ # @return [String]
1586
+ #
1587
+ # @!attribute [rw] template_name
1588
+ # The name of the version of an environment template.
1589
+ # @return [String]
1590
+ #
1591
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateVersion AWS API Documentation
1592
+ #
1593
+ class EnvironmentTemplateVersion < Struct.new(
1594
+ :arn,
1595
+ :created_at,
1596
+ :description,
1597
+ :last_modified_at,
1598
+ :major_version,
1599
+ :minor_version,
1600
+ :recommended_minor_version,
1601
+ :schema,
1602
+ :status,
1603
+ :status_message,
1604
+ :template_name)
1605
+ SENSITIVE = [:description, :schema, :status_message]
1606
+ include Aws::Structure
1607
+ end
1608
+
1609
+ # A summary of the version of an environment template detail data.
1610
+ #
1611
+ # @!attribute [rw] arn
1612
+ # The Amazon Resource Name (ARN) of the version of an environment
1613
+ # template.
1614
+ # @return [String]
1615
+ #
1616
+ # @!attribute [rw] created_at
1617
+ # The time when the version of an environment template was created.
1618
+ # @return [Time]
1619
+ #
1620
+ # @!attribute [rw] description
1621
+ # A description of the version of an environment template.
1622
+ # @return [String]
1623
+ #
1624
+ # @!attribute [rw] last_modified_at
1625
+ # The time when the version of an environment template was last
1626
+ # modified.
1627
+ # @return [Time]
1628
+ #
1629
+ # @!attribute [rw] major_version
1630
+ # The ID of the latest major version that's associated with the
1631
+ # version of an environment template.
1632
+ # @return [String]
1633
+ #
1634
+ # @!attribute [rw] minor_version
1635
+ # The ID of the version of an environment template.
1636
+ # @return [String]
1637
+ #
1638
+ # @!attribute [rw] recommended_minor_version
1639
+ # The ID of the recommended minor version of the environment template.
1640
+ # @return [String]
1641
+ #
1642
+ # @!attribute [rw] status
1643
+ # The status of the version of an environment template.
1644
+ # @return [String]
1645
+ #
1646
+ # @!attribute [rw] status_message
1647
+ # The status message of the version of an environment template.
1648
+ # @return [String]
1649
+ #
1650
+ # @!attribute [rw] template_name
1651
+ # The name of the version of an environment template.
1652
+ # @return [String]
1653
+ #
1654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/EnvironmentTemplateVersionSummary AWS API Documentation
1655
+ #
1656
+ class EnvironmentTemplateVersionSummary < Struct.new(
1657
+ :arn,
1658
+ :created_at,
1659
+ :description,
1660
+ :last_modified_at,
1661
+ :major_version,
1662
+ :minor_version,
1663
+ :recommended_minor_version,
1664
+ :status,
1665
+ :status_message,
1666
+ :template_name)
1667
+ SENSITIVE = [:description, :status_message]
1668
+ include Aws::Structure
1669
+ end
1670
+
1671
+ # @api private
1672
+ #
1673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetAccountSettingsInput AWS API Documentation
1674
+ #
1675
+ class GetAccountSettingsInput < Aws::EmptyStructure; end
1676
+
1677
+ # @!attribute [rw] account_settings
1678
+ # The AWS Proton pipeline service role detail data that's returned by
1679
+ # AWS Proton.
1680
+ # @return [Types::AccountSettings]
1681
+ #
1682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetAccountSettingsOutput AWS API Documentation
1683
+ #
1684
+ class GetAccountSettingsOutput < Struct.new(
1685
+ :account_settings)
1686
+ SENSITIVE = []
1687
+ include Aws::Structure
1688
+ end
1689
+
1690
+ # @note When making an API call, you may pass GetEnvironmentAccountConnectionInput
1691
+ # data as a hash:
1692
+ #
1693
+ # {
1694
+ # id: "EnvironmentAccountConnectionId", # required
1695
+ # }
1696
+ #
1697
+ # @!attribute [rw] id
1698
+ # The ID of the environment account connection.
1699
+ # @return [String]
1700
+ #
1701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnectionInput AWS API Documentation
1702
+ #
1703
+ class GetEnvironmentAccountConnectionInput < Struct.new(
1704
+ :id)
1705
+ SENSITIVE = []
1706
+ include Aws::Structure
1707
+ end
1708
+
1709
+ # @!attribute [rw] environment_account_connection
1710
+ # The environment account connection detail data that's returned by
1711
+ # AWS Proton.
1712
+ # @return [Types::EnvironmentAccountConnection]
1713
+ #
1714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnectionOutput AWS API Documentation
1715
+ #
1716
+ class GetEnvironmentAccountConnectionOutput < Struct.new(
1717
+ :environment_account_connection)
1718
+ SENSITIVE = []
1719
+ include Aws::Structure
1720
+ end
1721
+
1722
+ # @note When making an API call, you may pass GetEnvironmentInput
1723
+ # data as a hash:
1724
+ #
1725
+ # {
1726
+ # name: "ResourceName", # required
1727
+ # }
1728
+ #
1729
+ # @!attribute [rw] name
1730
+ # The name of the environment that you want to get the detail data
1731
+ # for.
1732
+ # @return [String]
1733
+ #
1734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentInput AWS API Documentation
1735
+ #
1736
+ class GetEnvironmentInput < Struct.new(
1737
+ :name)
1738
+ SENSITIVE = []
1739
+ include Aws::Structure
1740
+ end
1741
+
1742
+ # @!attribute [rw] environment
1743
+ # The environment detail data that's returned by AWS Proton.
1744
+ # @return [Types::Environment]
1745
+ #
1746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentOutput AWS API Documentation
1747
+ #
1748
+ class GetEnvironmentOutput < Struct.new(
1749
+ :environment)
1750
+ SENSITIVE = []
1751
+ include Aws::Structure
1752
+ end
1753
+
1754
+ # @note When making an API call, you may pass GetEnvironmentTemplateInput
1755
+ # data as a hash:
1756
+ #
1757
+ # {
1758
+ # name: "ResourceName", # required
1759
+ # }
1760
+ #
1761
+ # @!attribute [rw] name
1762
+ # The name of the environment template that you want to get the detail
1763
+ # data for.
1764
+ # @return [String]
1765
+ #
1766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateInput AWS API Documentation
1767
+ #
1768
+ class GetEnvironmentTemplateInput < Struct.new(
1769
+ :name)
1770
+ SENSITIVE = []
1771
+ include Aws::Structure
1772
+ end
1773
+
1774
+ # @!attribute [rw] environment_template
1775
+ # The environment template detail data that's returned by AWS Proton.
1776
+ # @return [Types::EnvironmentTemplate]
1777
+ #
1778
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateOutput AWS API Documentation
1779
+ #
1780
+ class GetEnvironmentTemplateOutput < Struct.new(
1781
+ :environment_template)
1782
+ SENSITIVE = []
1783
+ include Aws::Structure
1784
+ end
1785
+
1786
+ # @note When making an API call, you may pass GetEnvironmentTemplateVersionInput
1787
+ # data as a hash:
1788
+ #
1789
+ # {
1790
+ # major_version: "TemplateVersionPart", # required
1791
+ # minor_version: "TemplateVersionPart", # required
1792
+ # template_name: "ResourceName", # required
1793
+ # }
1794
+ #
1795
+ # @!attribute [rw] major_version
1796
+ # To view environment template major version detail data, include
1797
+ # `majorVersion`.
1798
+ # @return [String]
1799
+ #
1800
+ # @!attribute [rw] minor_version
1801
+ # To view environment template minor version detail data, include
1802
+ # `minorVersion`.
1803
+ # @return [String]
1804
+ #
1805
+ # @!attribute [rw] template_name
1806
+ # The name of the environment template.
1807
+ # @return [String]
1808
+ #
1809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersionInput AWS API Documentation
1810
+ #
1811
+ class GetEnvironmentTemplateVersionInput < Struct.new(
1812
+ :major_version,
1813
+ :minor_version,
1814
+ :template_name)
1815
+ SENSITIVE = []
1816
+ include Aws::Structure
1817
+ end
1818
+
1819
+ # @!attribute [rw] environment_template_version
1820
+ # The environment template version detail data that's returned by AWS
1821
+ # Proton.
1822
+ # @return [Types::EnvironmentTemplateVersion]
1823
+ #
1824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersionOutput AWS API Documentation
1825
+ #
1826
+ class GetEnvironmentTemplateVersionOutput < Struct.new(
1827
+ :environment_template_version)
1828
+ SENSITIVE = []
1829
+ include Aws::Structure
1830
+ end
1831
+
1832
+ # @note When making an API call, you may pass GetServiceInput
1833
+ # data as a hash:
1834
+ #
1835
+ # {
1836
+ # name: "ResourceName", # required
1837
+ # }
1838
+ #
1839
+ # @!attribute [rw] name
1840
+ # The name of the service that you want to get the detail data for.
1841
+ # @return [String]
1842
+ #
1843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInput AWS API Documentation
1844
+ #
1845
+ class GetServiceInput < Struct.new(
1846
+ :name)
1847
+ SENSITIVE = []
1848
+ include Aws::Structure
1849
+ end
1850
+
1851
+ # @note When making an API call, you may pass GetServiceInstanceInput
1852
+ # data as a hash:
1853
+ #
1854
+ # {
1855
+ # name: "ResourceName", # required
1856
+ # service_name: "ResourceName", # required
1857
+ # }
1858
+ #
1859
+ # @!attribute [rw] name
1860
+ # The name of a service instance that you want to get the detail data
1861
+ # for.
1862
+ # @return [String]
1863
+ #
1864
+ # @!attribute [rw] service_name
1865
+ # The name of the service that the service instance belongs to.
1866
+ # @return [String]
1867
+ #
1868
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceInput AWS API Documentation
1869
+ #
1870
+ class GetServiceInstanceInput < Struct.new(
1871
+ :name,
1872
+ :service_name)
1873
+ SENSITIVE = []
1874
+ include Aws::Structure
1875
+ end
1876
+
1877
+ # @!attribute [rw] service_instance
1878
+ # The service instance detail data that's returned by AWS Proton.
1879
+ # @return [Types::ServiceInstance]
1880
+ #
1881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstanceOutput AWS API Documentation
1882
+ #
1883
+ class GetServiceInstanceOutput < Struct.new(
1884
+ :service_instance)
1885
+ SENSITIVE = []
1886
+ include Aws::Structure
1887
+ end
1888
+
1889
+ # @!attribute [rw] service
1890
+ # The service detail data that's returned by AWS Proton.
1891
+ # @return [Types::Service]
1892
+ #
1893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceOutput AWS API Documentation
1894
+ #
1895
+ class GetServiceOutput < Struct.new(
1896
+ :service)
1897
+ SENSITIVE = []
1898
+ include Aws::Structure
1899
+ end
1900
+
1901
+ # @note When making an API call, you may pass GetServiceTemplateInput
1902
+ # data as a hash:
1903
+ #
1904
+ # {
1905
+ # name: "ResourceName", # required
1906
+ # }
1907
+ #
1908
+ # @!attribute [rw] name
1909
+ # The name of the service template that you want to get detail data
1910
+ # for.
1911
+ # @return [String]
1912
+ #
1913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateInput AWS API Documentation
1914
+ #
1915
+ class GetServiceTemplateInput < Struct.new(
1916
+ :name)
1917
+ SENSITIVE = []
1918
+ include Aws::Structure
1919
+ end
1920
+
1921
+ # @!attribute [rw] service_template
1922
+ # The service template detail data that's returned by AWS Proton.
1923
+ # @return [Types::ServiceTemplate]
1924
+ #
1925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateOutput AWS API Documentation
1926
+ #
1927
+ class GetServiceTemplateOutput < Struct.new(
1928
+ :service_template)
1929
+ SENSITIVE = []
1930
+ include Aws::Structure
1931
+ end
1932
+
1933
+ # @note When making an API call, you may pass GetServiceTemplateVersionInput
1934
+ # data as a hash:
1935
+ #
1936
+ # {
1937
+ # major_version: "TemplateVersionPart", # required
1938
+ # minor_version: "TemplateVersionPart", # required
1939
+ # template_name: "ResourceName", # required
1940
+ # }
1941
+ #
1942
+ # @!attribute [rw] major_version
1943
+ # To view service template major version detail data, include
1944
+ # `majorVersion`.
1945
+ # @return [String]
1946
+ #
1947
+ # @!attribute [rw] minor_version
1948
+ # To view service template minor version detail data, include
1949
+ # `minorVersion`.
1950
+ # @return [String]
1951
+ #
1952
+ # @!attribute [rw] template_name
1953
+ # The name of the service template.
1954
+ # @return [String]
1955
+ #
1956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersionInput AWS API Documentation
1957
+ #
1958
+ class GetServiceTemplateVersionInput < Struct.new(
1959
+ :major_version,
1960
+ :minor_version,
1961
+ :template_name)
1962
+ SENSITIVE = []
1963
+ include Aws::Structure
1964
+ end
1965
+
1966
+ # @!attribute [rw] service_template_version
1967
+ # The service template version detail data that's returned by AWS
1968
+ # Proton.
1969
+ # @return [Types::ServiceTemplateVersion]
1970
+ #
1971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersionOutput AWS API Documentation
1972
+ #
1973
+ class GetServiceTemplateVersionOutput < Struct.new(
1974
+ :service_template_version)
1975
+ SENSITIVE = []
1976
+ include Aws::Structure
1977
+ end
1978
+
1979
+ # The request failed to register with the service.
1980
+ #
1981
+ # @!attribute [rw] message
1982
+ # @return [String]
1983
+ #
1984
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/InternalServerException AWS API Documentation
1985
+ #
1986
+ class InternalServerException < Struct.new(
1987
+ :message)
1988
+ SENSITIVE = [:message]
1989
+ include Aws::Structure
1990
+ end
1991
+
1992
+ # @note When making an API call, you may pass ListEnvironmentAccountConnectionsInput
1993
+ # data as a hash:
1994
+ #
1995
+ # {
1996
+ # environment_name: "ResourceName",
1997
+ # max_results: 1,
1998
+ # next_token: "NextToken",
1999
+ # requested_by: "MANAGEMENT_ACCOUNT", # required, accepts MANAGEMENT_ACCOUNT, ENVIRONMENT_ACCOUNT
2000
+ # statuses: ["PENDING"], # accepts PENDING, CONNECTED, REJECTED
2001
+ # }
2002
+ #
2003
+ # @!attribute [rw] environment_name
2004
+ # The environment name that's associated with each listed environment
2005
+ # account connection.
2006
+ # @return [String]
2007
+ #
2008
+ # @!attribute [rw] max_results
2009
+ # The maximum number of environment account connections to list.
2010
+ # @return [Integer]
2011
+ #
2012
+ # @!attribute [rw] next_token
2013
+ # A token to indicate the location of the next environment account
2014
+ # connection in the array of environment account connections, after
2015
+ # the list of environment account connections that was previously
2016
+ # requested.
2017
+ # @return [String]
2018
+ #
2019
+ # @!attribute [rw] requested_by
2020
+ # The type of account making the `ListEnvironmentAccountConnections`
2021
+ # request.
2022
+ # @return [String]
2023
+ #
2024
+ # @!attribute [rw] statuses
2025
+ # The status details for each listed environment account connection.
2026
+ # @return [Array<String>]
2027
+ #
2028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentAccountConnectionsInput AWS API Documentation
2029
+ #
2030
+ class ListEnvironmentAccountConnectionsInput < Struct.new(
2031
+ :environment_name,
2032
+ :max_results,
2033
+ :next_token,
2034
+ :requested_by,
2035
+ :statuses)
2036
+ SENSITIVE = []
2037
+ include Aws::Structure
2038
+ end
2039
+
2040
+ # @!attribute [rw] environment_account_connections
2041
+ # An array of environment account connections with details that's
2042
+ # returned by AWS Proton.
2043
+ # @return [Array<Types::EnvironmentAccountConnectionSummary>]
2044
+ #
2045
+ # @!attribute [rw] next_token
2046
+ # A token to indicate the location of the next environment account
2047
+ # connection in the array of environment account connections, after
2048
+ # the current requested list of environment account connections.
2049
+ # @return [String]
2050
+ #
2051
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentAccountConnectionsOutput AWS API Documentation
2052
+ #
2053
+ class ListEnvironmentAccountConnectionsOutput < Struct.new(
2054
+ :environment_account_connections,
2055
+ :next_token)
2056
+ SENSITIVE = []
2057
+ include Aws::Structure
2058
+ end
2059
+
2060
+ # @note When making an API call, you may pass ListEnvironmentTemplateVersionsInput
2061
+ # data as a hash:
2062
+ #
2063
+ # {
2064
+ # major_version: "TemplateVersionPart",
2065
+ # max_results: 1,
2066
+ # next_token: "NextToken",
2067
+ # template_name: "ResourceName", # required
2068
+ # }
2069
+ #
2070
+ # @!attribute [rw] major_version
2071
+ # To view a list of minor of versions under a major version of an
2072
+ # environment template, include `majorVersion`.
2073
+ #
2074
+ # To view a list of major versions of an environment template,
2075
+ # *exclude* `majorVersion`.
2076
+ # @return [String]
2077
+ #
2078
+ # @!attribute [rw] max_results
2079
+ # The maximum number of major or minor versions of an environment
2080
+ # template to list.
2081
+ # @return [Integer]
2082
+ #
2083
+ # @!attribute [rw] next_token
2084
+ # A token to indicate the location of the next major or minor version
2085
+ # in the array of major or minor versions of an environment template,
2086
+ # after the list of major or minor versions that was previously
2087
+ # requested.
2088
+ # @return [String]
2089
+ #
2090
+ # @!attribute [rw] template_name
2091
+ # The name of the environment template.
2092
+ # @return [String]
2093
+ #
2094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplateVersionsInput AWS API Documentation
2095
+ #
2096
+ class ListEnvironmentTemplateVersionsInput < Struct.new(
2097
+ :major_version,
2098
+ :max_results,
2099
+ :next_token,
2100
+ :template_name)
2101
+ SENSITIVE = []
2102
+ include Aws::Structure
2103
+ end
2104
+
2105
+ # @!attribute [rw] next_token
2106
+ # A token to indicate the location of the next major or minor version
2107
+ # in the array of major or minor versions of an environment template,
2108
+ # after the list of major or minor versions that was previously
2109
+ # requested.
2110
+ # @return [String]
2111
+ #
2112
+ # @!attribute [rw] template_versions
2113
+ # An array of major or minor versions of an environment template
2114
+ # detail data.
2115
+ # @return [Array<Types::EnvironmentTemplateVersionSummary>]
2116
+ #
2117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplateVersionsOutput AWS API Documentation
2118
+ #
2119
+ class ListEnvironmentTemplateVersionsOutput < Struct.new(
2120
+ :next_token,
2121
+ :template_versions)
2122
+ SENSITIVE = []
2123
+ include Aws::Structure
2124
+ end
2125
+
2126
+ # @note When making an API call, you may pass ListEnvironmentTemplatesInput
2127
+ # data as a hash:
2128
+ #
2129
+ # {
2130
+ # max_results: 1,
2131
+ # next_token: "NextToken",
2132
+ # }
2133
+ #
2134
+ # @!attribute [rw] max_results
2135
+ # The maximum number of environment templates to list.
2136
+ # @return [Integer]
2137
+ #
2138
+ # @!attribute [rw] next_token
2139
+ # A token to indicate the location of the next environment template in
2140
+ # the array of environment templates, after the list of environment
2141
+ # templates that was previously requested.
2142
+ # @return [String]
2143
+ #
2144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplatesInput AWS API Documentation
2145
+ #
2146
+ class ListEnvironmentTemplatesInput < Struct.new(
2147
+ :max_results,
2148
+ :next_token)
2149
+ SENSITIVE = []
2150
+ include Aws::Structure
2151
+ end
2152
+
2153
+ # @!attribute [rw] next_token
2154
+ # A token to indicate the location of the next environment template in
2155
+ # the array of environment templates, after the current requested list
2156
+ # of environment templates.
2157
+ # @return [String]
2158
+ #
2159
+ # @!attribute [rw] templates
2160
+ # An array of environment templates with detail data.
2161
+ # @return [Array<Types::EnvironmentTemplateSummary>]
2162
+ #
2163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplatesOutput AWS API Documentation
2164
+ #
2165
+ class ListEnvironmentTemplatesOutput < Struct.new(
2166
+ :next_token,
2167
+ :templates)
2168
+ SENSITIVE = []
2169
+ include Aws::Structure
2170
+ end
2171
+
2172
+ # @note When making an API call, you may pass ListEnvironmentsInput
2173
+ # data as a hash:
2174
+ #
2175
+ # {
2176
+ # environment_templates: [
2177
+ # {
2178
+ # major_version: "TemplateVersionPart", # required
2179
+ # template_name: "ResourceName", # required
2180
+ # },
2181
+ # ],
2182
+ # max_results: 1,
2183
+ # next_token: "NextToken",
2184
+ # }
2185
+ #
2186
+ # @!attribute [rw] environment_templates
2187
+ # An array of the versions of the environment template.
2188
+ # @return [Array<Types::EnvironmentTemplateFilter>]
2189
+ #
2190
+ # @!attribute [rw] max_results
2191
+ # The maximum number of environments to list.
2192
+ # @return [Integer]
2193
+ #
2194
+ # @!attribute [rw] next_token
2195
+ # A token to indicate the location of the next environment in the
2196
+ # array of environments, after the list of environments that was
2197
+ # previously requested.
2198
+ # @return [String]
2199
+ #
2200
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentsInput AWS API Documentation
2201
+ #
2202
+ class ListEnvironmentsInput < Struct.new(
2203
+ :environment_templates,
2204
+ :max_results,
2205
+ :next_token)
2206
+ SENSITIVE = []
2207
+ include Aws::Structure
2208
+ end
2209
+
2210
+ # @!attribute [rw] environments
2211
+ # An array of environment detail data summaries.
2212
+ # @return [Array<Types::EnvironmentSummary>]
2213
+ #
2214
+ # @!attribute [rw] next_token
2215
+ # A token to indicate the location of the next environment in the
2216
+ # array of environments, after the current requested list of
2217
+ # environments.
2218
+ # @return [String]
2219
+ #
2220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentsOutput AWS API Documentation
2221
+ #
2222
+ class ListEnvironmentsOutput < Struct.new(
2223
+ :environments,
2224
+ :next_token)
2225
+ SENSITIVE = []
2226
+ include Aws::Structure
2227
+ end
2228
+
2229
+ # @note When making an API call, you may pass ListServiceInstancesInput
2230
+ # data as a hash:
2231
+ #
2232
+ # {
2233
+ # max_results: 1,
2234
+ # next_token: "NextToken",
2235
+ # service_name: "ResourceName",
2236
+ # }
2237
+ #
2238
+ # @!attribute [rw] max_results
2239
+ # The maximum number of service instances to list.
2240
+ # @return [Integer]
2241
+ #
2242
+ # @!attribute [rw] next_token
2243
+ # A token to indicate the location of the next service in the array of
2244
+ # service instances, after the list of service instances that was
2245
+ # previously requested.
2246
+ # @return [String]
2247
+ #
2248
+ # @!attribute [rw] service_name
2249
+ # The name of the service that the service instance belongs to.
2250
+ # @return [String]
2251
+ #
2252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstancesInput AWS API Documentation
2253
+ #
2254
+ class ListServiceInstancesInput < Struct.new(
2255
+ :max_results,
2256
+ :next_token,
2257
+ :service_name)
2258
+ SENSITIVE = []
2259
+ include Aws::Structure
2260
+ end
2261
+
2262
+ # @!attribute [rw] next_token
2263
+ # A token to indicate the location of the next service instance in the
2264
+ # array of service instances, after the current requested list of
2265
+ # service instances.
2266
+ # @return [String]
2267
+ #
2268
+ # @!attribute [rw] service_instances
2269
+ # An array of service instances with summaries of detail data.
2270
+ # @return [Array<Types::ServiceInstanceSummary>]
2271
+ #
2272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstancesOutput AWS API Documentation
2273
+ #
2274
+ class ListServiceInstancesOutput < Struct.new(
2275
+ :next_token,
2276
+ :service_instances)
2277
+ SENSITIVE = []
2278
+ include Aws::Structure
2279
+ end
2280
+
2281
+ # @note When making an API call, you may pass ListServiceTemplateVersionsInput
2282
+ # data as a hash:
2283
+ #
2284
+ # {
2285
+ # major_version: "TemplateVersionPart",
2286
+ # max_results: 1,
2287
+ # next_token: "NextToken",
2288
+ # template_name: "ResourceName", # required
2289
+ # }
2290
+ #
2291
+ # @!attribute [rw] major_version
2292
+ # To view a list of minor of versions under a major version of a
2293
+ # service template, include `majorVersion`.
2294
+ #
2295
+ # To view a list of major versions of a service template, *exclude*
2296
+ # `majorVersion`.
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] max_results
2300
+ # The maximum number of major or minor versions of a service template
2301
+ # to list.
2302
+ # @return [Integer]
2303
+ #
2304
+ # @!attribute [rw] next_token
2305
+ # A token to indicate the location of the next major or minor version
2306
+ # in the array of major or minor versions of a service template, after
2307
+ # the list of major or minor versions that was previously requested.
2308
+ # @return [String]
2309
+ #
2310
+ # @!attribute [rw] template_name
2311
+ # The name of the service template.
2312
+ # @return [String]
2313
+ #
2314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplateVersionsInput AWS API Documentation
2315
+ #
2316
+ class ListServiceTemplateVersionsInput < Struct.new(
2317
+ :major_version,
2318
+ :max_results,
2319
+ :next_token,
2320
+ :template_name)
2321
+ SENSITIVE = []
2322
+ include Aws::Structure
2323
+ end
2324
+
2325
+ # @!attribute [rw] next_token
2326
+ # A token to indicate the location of the next major or minor version
2327
+ # in the array of major or minor versions of a service template, after
2328
+ # the list of major or minor versions that was previously requested.
2329
+ # @return [String]
2330
+ #
2331
+ # @!attribute [rw] template_versions
2332
+ # An array of major or minor versions of a service template with
2333
+ # detail data.
2334
+ # @return [Array<Types::ServiceTemplateVersionSummary>]
2335
+ #
2336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplateVersionsOutput AWS API Documentation
2337
+ #
2338
+ class ListServiceTemplateVersionsOutput < Struct.new(
2339
+ :next_token,
2340
+ :template_versions)
2341
+ SENSITIVE = []
2342
+ include Aws::Structure
2343
+ end
2344
+
2345
+ # @note When making an API call, you may pass ListServiceTemplatesInput
2346
+ # data as a hash:
2347
+ #
2348
+ # {
2349
+ # max_results: 1,
2350
+ # next_token: "NextToken",
2351
+ # }
2352
+ #
2353
+ # @!attribute [rw] max_results
2354
+ # The maximum number of service templates to list.
2355
+ # @return [Integer]
2356
+ #
2357
+ # @!attribute [rw] next_token
2358
+ # A token to indicate the location of the next service template in the
2359
+ # array of service templates, after the list of service templates
2360
+ # previously requested.
2361
+ # @return [String]
2362
+ #
2363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplatesInput AWS API Documentation
2364
+ #
2365
+ class ListServiceTemplatesInput < Struct.new(
2366
+ :max_results,
2367
+ :next_token)
2368
+ SENSITIVE = []
2369
+ include Aws::Structure
2370
+ end
2371
+
2372
+ # @!attribute [rw] next_token
2373
+ # A token to indicate the location of the next service template in the
2374
+ # array of service templates, after the current requested list of
2375
+ # service templates.
2376
+ # @return [String]
2377
+ #
2378
+ # @!attribute [rw] templates
2379
+ # An array of service templates with detail data.
2380
+ # @return [Array<Types::ServiceTemplateSummary>]
2381
+ #
2382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplatesOutput AWS API Documentation
2383
+ #
2384
+ class ListServiceTemplatesOutput < Struct.new(
2385
+ :next_token,
2386
+ :templates)
2387
+ SENSITIVE = []
2388
+ include Aws::Structure
2389
+ end
2390
+
2391
+ # @note When making an API call, you may pass ListServicesInput
2392
+ # data as a hash:
2393
+ #
2394
+ # {
2395
+ # max_results: 1,
2396
+ # next_token: "NextToken",
2397
+ # }
2398
+ #
2399
+ # @!attribute [rw] max_results
2400
+ # The maximum number of services to list.
2401
+ # @return [Integer]
2402
+ #
2403
+ # @!attribute [rw] next_token
2404
+ # A token to indicate the location of the next service in the array of
2405
+ # services, after the list of services that was previously requested.
2406
+ # @return [String]
2407
+ #
2408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicesInput AWS API Documentation
2409
+ #
2410
+ class ListServicesInput < Struct.new(
2411
+ :max_results,
2412
+ :next_token)
2413
+ SENSITIVE = []
2414
+ include Aws::Structure
2415
+ end
2416
+
2417
+ # @!attribute [rw] next_token
2418
+ # A token to indicate the location of the next service in the array of
2419
+ # services, after the current requested list of services.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] services
2423
+ # An array of services with summaries of detail data.
2424
+ # @return [Array<Types::ServiceSummary>]
2425
+ #
2426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServicesOutput AWS API Documentation
2427
+ #
2428
+ class ListServicesOutput < Struct.new(
2429
+ :next_token,
2430
+ :services)
2431
+ SENSITIVE = []
2432
+ include Aws::Structure
2433
+ end
2434
+
2435
+ # @note When making an API call, you may pass ListTagsForResourceInput
2436
+ # data as a hash:
2437
+ #
2438
+ # {
2439
+ # max_results: 1,
2440
+ # next_token: "String",
2441
+ # resource_arn: "Arn", # required
2442
+ # }
2443
+ #
2444
+ # @!attribute [rw] max_results
2445
+ # The maximum number of tags to list.
2446
+ # @return [Integer]
2447
+ #
2448
+ # @!attribute [rw] next_token
2449
+ # A token to indicate the location of the next resource tag in the
2450
+ # array of resource tags, after the list of resource tags that was
2451
+ # previously requested.
2452
+ # @return [String]
2453
+ #
2454
+ # @!attribute [rw] resource_arn
2455
+ # The ARN of the resource for the listed tags.
2456
+ # @return [String]
2457
+ #
2458
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListTagsForResourceInput AWS API Documentation
2459
+ #
2460
+ class ListTagsForResourceInput < Struct.new(
2461
+ :max_results,
2462
+ :next_token,
2463
+ :resource_arn)
2464
+ SENSITIVE = []
2465
+ include Aws::Structure
2466
+ end
2467
+
2468
+ # @!attribute [rw] next_token
2469
+ # A token to indicate the location of the next resource tag in the
2470
+ # array of resource tags, after the current requested list of resource
2471
+ # tags.
2472
+ # @return [String]
2473
+ #
2474
+ # @!attribute [rw] tags
2475
+ # An array of resource tags with detail data.
2476
+ # @return [Array<Types::Tag>]
2477
+ #
2478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListTagsForResourceOutput AWS API Documentation
2479
+ #
2480
+ class ListTagsForResourceOutput < Struct.new(
2481
+ :next_token,
2482
+ :tags)
2483
+ SENSITIVE = []
2484
+ include Aws::Structure
2485
+ end
2486
+
2487
+ # @note When making an API call, you may pass RejectEnvironmentAccountConnectionInput
2488
+ # data as a hash:
2489
+ #
2490
+ # {
2491
+ # id: "EnvironmentAccountConnectionId", # required
2492
+ # }
2493
+ #
2494
+ # @!attribute [rw] id
2495
+ # The ID of the environment account connection to reject.
2496
+ # @return [String]
2497
+ #
2498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RejectEnvironmentAccountConnectionInput AWS API Documentation
2499
+ #
2500
+ class RejectEnvironmentAccountConnectionInput < Struct.new(
2501
+ :id)
2502
+ SENSITIVE = []
2503
+ include Aws::Structure
2504
+ end
2505
+
2506
+ # @!attribute [rw] environment_account_connection
2507
+ # The environment connection account detail data that's returned by
2508
+ # AWS Proton.
2509
+ # @return [Types::EnvironmentAccountConnection]
2510
+ #
2511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RejectEnvironmentAccountConnectionOutput AWS API Documentation
2512
+ #
2513
+ class RejectEnvironmentAccountConnectionOutput < Struct.new(
2514
+ :environment_account_connection)
2515
+ SENSITIVE = []
2516
+ include Aws::Structure
2517
+ end
2518
+
2519
+ # The requested resource *wasn't* found.
2520
+ #
2521
+ # @!attribute [rw] message
2522
+ # @return [String]
2523
+ #
2524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ResourceNotFoundException AWS API Documentation
2525
+ #
2526
+ class ResourceNotFoundException < Struct.new(
2527
+ :message)
2528
+ SENSITIVE = [:message]
2529
+ include Aws::Structure
2530
+ end
2531
+
2532
+ # Template bundle S3 bucket data.
2533
+ #
2534
+ # @note When making an API call, you may pass S3ObjectSource
2535
+ # data as a hash:
2536
+ #
2537
+ # {
2538
+ # bucket: "S3Bucket", # required
2539
+ # key: "S3Key", # required
2540
+ # }
2541
+ #
2542
+ # @!attribute [rw] bucket
2543
+ # The name of the S3 bucket that contains a template bundle.
2544
+ # @return [String]
2545
+ #
2546
+ # @!attribute [rw] key
2547
+ # The path to the S3 bucket that contains a template bundle.
2548
+ # @return [String]
2549
+ #
2550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/S3ObjectSource AWS API Documentation
2551
+ #
2552
+ class S3ObjectSource < Struct.new(
2553
+ :bucket,
2554
+ :key)
2555
+ SENSITIVE = []
2556
+ include Aws::Structure
2557
+ end
2558
+
2559
+ # The service detail data.
2560
+ #
2561
+ # @!attribute [rw] arn
2562
+ # The Amazon Resource Name (ARN) of the service.
2563
+ # @return [String]
2564
+ #
2565
+ # @!attribute [rw] branch_name
2566
+ # The name of the code repository branch that holds the code that's
2567
+ # deployed in AWS Proton.
2568
+ # @return [String]
2569
+ #
2570
+ # @!attribute [rw] created_at
2571
+ # The time when the service was created.
2572
+ # @return [Time]
2573
+ #
2574
+ # @!attribute [rw] description
2575
+ # A description of a service.
2576
+ # @return [String]
2577
+ #
2578
+ # @!attribute [rw] last_modified_at
2579
+ # The time when the service was last modified.
2580
+ # @return [Time]
2581
+ #
2582
+ # @!attribute [rw] name
2583
+ # The name of the service.
2584
+ # @return [String]
2585
+ #
2586
+ # @!attribute [rw] pipeline
2587
+ # The service pipeline detail data.
2588
+ # @return [Types::ServicePipeline]
2589
+ #
2590
+ # @!attribute [rw] repository_connection_arn
2591
+ # The ARN of the repository connection. For more information, see [Set
2592
+ # up a repository connection][1] in the *AWS Proton Administration
2593
+ # Guide* and [Getting started][2] in the *AWS Proton User Guide*.
2594
+ #
2595
+ #
2596
+ #
2597
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#setting-up-vcontrol
2598
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-getting-started.html#getting-started-step1
2599
+ # @return [String]
2600
+ #
2601
+ # @!attribute [rw] repository_id
2602
+ # The ID of the code repository.
2603
+ # @return [String]
2604
+ #
2605
+ # @!attribute [rw] spec
2606
+ # The formatted specification that defines the service.
2607
+ # @return [String]
2608
+ #
2609
+ # @!attribute [rw] status
2610
+ # The status of the service.
2611
+ # @return [String]
2612
+ #
2613
+ # @!attribute [rw] status_message
2614
+ # A service status message.
2615
+ # @return [String]
2616
+ #
2617
+ # @!attribute [rw] template_name
2618
+ # The name of the service template.
2619
+ # @return [String]
2620
+ #
2621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Service AWS API Documentation
2622
+ #
2623
+ class Service < Struct.new(
2624
+ :arn,
2625
+ :branch_name,
2626
+ :created_at,
2627
+ :description,
2628
+ :last_modified_at,
2629
+ :name,
2630
+ :pipeline,
2631
+ :repository_connection_arn,
2632
+ :repository_id,
2633
+ :spec,
2634
+ :status,
2635
+ :status_message,
2636
+ :template_name)
2637
+ SENSITIVE = [:description, :spec, :status_message]
2638
+ include Aws::Structure
2639
+ end
2640
+
2641
+ # The service instance detail data.
2642
+ #
2643
+ # @!attribute [rw] arn
2644
+ # The Amazon Resource Name (ARN) of the service instance.
2645
+ # @return [String]
2646
+ #
2647
+ # @!attribute [rw] created_at
2648
+ # The time when the service instance was created.
2649
+ # @return [Time]
2650
+ #
2651
+ # @!attribute [rw] deployment_status
2652
+ # The service instance deployment status.
2653
+ # @return [String]
2654
+ #
2655
+ # @!attribute [rw] deployment_status_message
2656
+ # A service instance deployment status message.
2657
+ # @return [String]
2658
+ #
2659
+ # @!attribute [rw] environment_name
2660
+ # The name of the environment that the service instance was deployed
2661
+ # into.
2662
+ # @return [String]
2663
+ #
2664
+ # @!attribute [rw] last_deployment_attempted_at
2665
+ # The time when a deployment of the service instance was last
2666
+ # attempted.
2667
+ # @return [Time]
2668
+ #
2669
+ # @!attribute [rw] last_deployment_succeeded_at
2670
+ # The time when the service instance was last deployed successfully.
2671
+ # @return [Time]
2672
+ #
2673
+ # @!attribute [rw] name
2674
+ # The name of the service instance.
2675
+ # @return [String]
2676
+ #
2677
+ # @!attribute [rw] service_name
2678
+ # The name of the service that the service instance belongs to.
2679
+ # @return [String]
2680
+ #
2681
+ # @!attribute [rw] spec
2682
+ # The service spec that was used to create the service instance.
2683
+ # @return [String]
2684
+ #
2685
+ # @!attribute [rw] template_major_version
2686
+ # The ID of the major version of the service template that was used to
2687
+ # create the service instance.
2688
+ # @return [String]
2689
+ #
2690
+ # @!attribute [rw] template_minor_version
2691
+ # The ID of the minor version of the service template that was used to
2692
+ # create the service instance.
2693
+ # @return [String]
2694
+ #
2695
+ # @!attribute [rw] template_name
2696
+ # The name of the service template that was used to create the service
2697
+ # instance.
2698
+ # @return [String]
2699
+ #
2700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceInstance AWS API Documentation
2701
+ #
2702
+ class ServiceInstance < Struct.new(
2703
+ :arn,
2704
+ :created_at,
2705
+ :deployment_status,
2706
+ :deployment_status_message,
2707
+ :environment_name,
2708
+ :last_deployment_attempted_at,
2709
+ :last_deployment_succeeded_at,
2710
+ :name,
2711
+ :service_name,
2712
+ :spec,
2713
+ :template_major_version,
2714
+ :template_minor_version,
2715
+ :template_name)
2716
+ SENSITIVE = [:deployment_status_message, :spec]
2717
+ include Aws::Structure
2718
+ end
2719
+
2720
+ # A summary of the service instance detail data.
2721
+ #
2722
+ # @!attribute [rw] arn
2723
+ # The Amazon Resource Name (ARN) of the service instance.
2724
+ # @return [String]
2725
+ #
2726
+ # @!attribute [rw] created_at
2727
+ # The time when the service instance was created.
2728
+ # @return [Time]
2729
+ #
2730
+ # @!attribute [rw] deployment_status
2731
+ # The service instance deployment status.
2732
+ # @return [String]
2733
+ #
2734
+ # @!attribute [rw] deployment_status_message
2735
+ # A service instance deployment status message.
2736
+ # @return [String]
2737
+ #
2738
+ # @!attribute [rw] environment_name
2739
+ # The name of the environment that the service instance was deployed
2740
+ # into.
2741
+ # @return [String]
2742
+ #
2743
+ # @!attribute [rw] last_deployment_attempted_at
2744
+ # The time when a deployment of the service was last attempted.
2745
+ # @return [Time]
2746
+ #
2747
+ # @!attribute [rw] last_deployment_succeeded_at
2748
+ # The time when the service was last deployed successfully.
2749
+ # @return [Time]
2750
+ #
2751
+ # @!attribute [rw] name
2752
+ # The name of the service instance.
2753
+ # @return [String]
2754
+ #
2755
+ # @!attribute [rw] service_name
2756
+ # The name of the service that the service instance belongs to.
2757
+ # @return [String]
2758
+ #
2759
+ # @!attribute [rw] template_major_version
2760
+ # The ID of the major version of a service template.
2761
+ # @return [String]
2762
+ #
2763
+ # @!attribute [rw] template_minor_version
2764
+ # The ID of the minor version of a service template.
2765
+ # @return [String]
2766
+ #
2767
+ # @!attribute [rw] template_name
2768
+ # The name of the service template.
2769
+ # @return [String]
2770
+ #
2771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceInstanceSummary AWS API Documentation
2772
+ #
2773
+ class ServiceInstanceSummary < Struct.new(
2774
+ :arn,
2775
+ :created_at,
2776
+ :deployment_status,
2777
+ :deployment_status_message,
2778
+ :environment_name,
2779
+ :last_deployment_attempted_at,
2780
+ :last_deployment_succeeded_at,
2781
+ :name,
2782
+ :service_name,
2783
+ :template_major_version,
2784
+ :template_minor_version,
2785
+ :template_name)
2786
+ SENSITIVE = [:deployment_status_message]
2787
+ include Aws::Structure
2788
+ end
2789
+
2790
+ # The service pipeline detail data.
2791
+ #
2792
+ # @!attribute [rw] arn
2793
+ # The Amazon Resource Name (ARN) of the service pipeline.
2794
+ # @return [String]
2795
+ #
2796
+ # @!attribute [rw] created_at
2797
+ # The time when the service pipeline was created.
2798
+ # @return [Time]
2799
+ #
2800
+ # @!attribute [rw] deployment_status
2801
+ # The deployment status of the service pipeline.
2802
+ # @return [String]
2803
+ #
2804
+ # @!attribute [rw] deployment_status_message
2805
+ # A service pipeline deployment status message.
2806
+ # @return [String]
2807
+ #
2808
+ # @!attribute [rw] last_deployment_attempted_at
2809
+ # The time when a deployment of the service pipeline was last
2810
+ # attempted.
2811
+ # @return [Time]
2812
+ #
2813
+ # @!attribute [rw] last_deployment_succeeded_at
2814
+ # The time when the service pipeline was last deployed successfully.
2815
+ # @return [Time]
2816
+ #
2817
+ # @!attribute [rw] spec
2818
+ # The service spec that was used to create the service pipeline.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] template_major_version
2822
+ # The ID of the major version of the service template that was used to
2823
+ # create the service pipeline.
2824
+ # @return [String]
2825
+ #
2826
+ # @!attribute [rw] template_minor_version
2827
+ # The ID of the minor version of the service template that was used to
2828
+ # create the service pipeline.
2829
+ # @return [String]
2830
+ #
2831
+ # @!attribute [rw] template_name
2832
+ # The name of the service template that was used to create the service
2833
+ # pipeline.
2834
+ # @return [String]
2835
+ #
2836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServicePipeline AWS API Documentation
2837
+ #
2838
+ class ServicePipeline < Struct.new(
2839
+ :arn,
2840
+ :created_at,
2841
+ :deployment_status,
2842
+ :deployment_status_message,
2843
+ :last_deployment_attempted_at,
2844
+ :last_deployment_succeeded_at,
2845
+ :spec,
2846
+ :template_major_version,
2847
+ :template_minor_version,
2848
+ :template_name)
2849
+ SENSITIVE = [:deployment_status_message, :spec]
2850
+ include Aws::Structure
2851
+ end
2852
+
2853
+ # A quota was exceeded. For more information, see [AWS Proton Quotas][1]
2854
+ # in the *AWS Proton Administration Guide*.
2855
+ #
2856
+ #
2857
+ #
2858
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-limits.html
2859
+ #
2860
+ # @!attribute [rw] message
2861
+ # @return [String]
2862
+ #
2863
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceQuotaExceededException AWS API Documentation
2864
+ #
2865
+ class ServiceQuotaExceededException < Struct.new(
2866
+ :message)
2867
+ SENSITIVE = [:message]
2868
+ include Aws::Structure
2869
+ end
2870
+
2871
+ # A summary of the service detail data.
2872
+ #
2873
+ # @!attribute [rw] arn
2874
+ # The Amazon Resource Name (ARN) of the service.
2875
+ # @return [String]
2876
+ #
2877
+ # @!attribute [rw] created_at
2878
+ # The time when the service was created.
2879
+ # @return [Time]
2880
+ #
2881
+ # @!attribute [rw] description
2882
+ # A description of the service.
2883
+ # @return [String]
2884
+ #
2885
+ # @!attribute [rw] last_modified_at
2886
+ # The time when the service was last modified.
2887
+ # @return [Time]
2888
+ #
2889
+ # @!attribute [rw] name
2890
+ # The name of the service.
2891
+ # @return [String]
2892
+ #
2893
+ # @!attribute [rw] status
2894
+ # The status of the service.
2895
+ # @return [String]
2896
+ #
2897
+ # @!attribute [rw] status_message
2898
+ # A service status message.
2899
+ # @return [String]
2900
+ #
2901
+ # @!attribute [rw] template_name
2902
+ # The name of the service template.
2903
+ # @return [String]
2904
+ #
2905
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceSummary AWS API Documentation
2906
+ #
2907
+ class ServiceSummary < Struct.new(
2908
+ :arn,
2909
+ :created_at,
2910
+ :description,
2911
+ :last_modified_at,
2912
+ :name,
2913
+ :status,
2914
+ :status_message,
2915
+ :template_name)
2916
+ SENSITIVE = [:description, :status_message]
2917
+ include Aws::Structure
2918
+ end
2919
+
2920
+ # The service template detail data.
2921
+ #
2922
+ # @!attribute [rw] arn
2923
+ # The Amazon Resource Name (ARN) of the service template.
2924
+ # @return [String]
2925
+ #
2926
+ # @!attribute [rw] created_at
2927
+ # The time when the service template was created.
2928
+ # @return [Time]
2929
+ #
2930
+ # @!attribute [rw] description
2931
+ # A description of the service template.
2932
+ # @return [String]
2933
+ #
2934
+ # @!attribute [rw] display_name
2935
+ # The service template name as displayed in the developer interface.
2936
+ # @return [String]
2937
+ #
2938
+ # @!attribute [rw] encryption_key
2939
+ # The customer provided service template encryption key that's used
2940
+ # to encrypt data.
2941
+ # @return [String]
2942
+ #
2943
+ # @!attribute [rw] last_modified_at
2944
+ # The time when the service template was last modified.
2945
+ # @return [Time]
2946
+ #
2947
+ # @!attribute [rw] name
2948
+ # The name of the service template.
2949
+ # @return [String]
2950
+ #
2951
+ # @!attribute [rw] pipeline_provisioning
2952
+ # If `pipelineProvisioning` is `true`, a service pipeline is included
2953
+ # in the service template. Otherwise, a service pipeline *isn't*
2954
+ # included in the service template.
2955
+ # @return [String]
2956
+ #
2957
+ # @!attribute [rw] recommended_version
2958
+ # The ID of the recommended version of the service template.
2959
+ # @return [String]
2960
+ #
2961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplate AWS API Documentation
2962
+ #
2963
+ class ServiceTemplate < Struct.new(
2964
+ :arn,
2965
+ :created_at,
2966
+ :description,
2967
+ :display_name,
2968
+ :encryption_key,
2969
+ :last_modified_at,
2970
+ :name,
2971
+ :pipeline_provisioning,
2972
+ :recommended_version)
2973
+ SENSITIVE = [:description, :display_name]
2974
+ include Aws::Structure
2975
+ end
2976
+
2977
+ # The service template summary data.
2978
+ #
2979
+ # @!attribute [rw] arn
2980
+ # The Amazon Resource Name (ARN) of the service template.
2981
+ # @return [String]
2982
+ #
2983
+ # @!attribute [rw] created_at
2984
+ # The time when the service template was created.
2985
+ # @return [Time]
2986
+ #
2987
+ # @!attribute [rw] description
2988
+ # A description of the service template.
2989
+ # @return [String]
2990
+ #
2991
+ # @!attribute [rw] display_name
2992
+ # The service template name as displayed in the developer interface.
2993
+ # @return [String]
2994
+ #
2995
+ # @!attribute [rw] last_modified_at
2996
+ # The time when the service template was last modified.
2997
+ # @return [Time]
2998
+ #
2999
+ # @!attribute [rw] name
3000
+ # The name of the service template.
3001
+ # @return [String]
3002
+ #
3003
+ # @!attribute [rw] pipeline_provisioning
3004
+ # If `pipelineProvisioning` is `true`, a service pipeline is included
3005
+ # in the service template, otherwise a service pipeline *isn't*
3006
+ # included in the service template.
3007
+ # @return [String]
3008
+ #
3009
+ # @!attribute [rw] recommended_version
3010
+ # The ID of the recommended version of the service template.
3011
+ # @return [String]
3012
+ #
3013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplateSummary AWS API Documentation
3014
+ #
3015
+ class ServiceTemplateSummary < Struct.new(
3016
+ :arn,
3017
+ :created_at,
3018
+ :description,
3019
+ :display_name,
3020
+ :last_modified_at,
3021
+ :name,
3022
+ :pipeline_provisioning,
3023
+ :recommended_version)
3024
+ SENSITIVE = [:description, :display_name]
3025
+ include Aws::Structure
3026
+ end
3027
+
3028
+ # The version of a service template detail data.
3029
+ #
3030
+ # @!attribute [rw] arn
3031
+ # The Amazon Resource Name (ARN) of the version of a service template.
3032
+ # @return [String]
3033
+ #
3034
+ # @!attribute [rw] compatible_environment_templates
3035
+ # An array of compatible environment template names for the major
3036
+ # version of a service template.
3037
+ # @return [Array<Types::CompatibleEnvironmentTemplate>]
3038
+ #
3039
+ # @!attribute [rw] created_at
3040
+ # The time when the version of a service template was created.
3041
+ # @return [Time]
3042
+ #
3043
+ # @!attribute [rw] description
3044
+ # A description of the version of a service template.
3045
+ # @return [String]
3046
+ #
3047
+ # @!attribute [rw] last_modified_at
3048
+ # The time when the version of a service template was last modified.
3049
+ # @return [Time]
3050
+ #
3051
+ # @!attribute [rw] major_version
3052
+ # The ID of the latest major version that's associated with the
3053
+ # version of a service template.
3054
+ # @return [String]
3055
+ #
3056
+ # @!attribute [rw] minor_version
3057
+ # The ID of the minor version of a service template.
3058
+ # @return [String]
3059
+ #
3060
+ # @!attribute [rw] recommended_minor_version
3061
+ # The ID of the recommended minor version of the service template.
3062
+ # @return [String]
3063
+ #
3064
+ # @!attribute [rw] schema
3065
+ # The schema of the version of a service template.
3066
+ # @return [String]
3067
+ #
3068
+ # @!attribute [rw] status
3069
+ # The service template version status.
3070
+ # @return [String]
3071
+ #
3072
+ # @!attribute [rw] status_message
3073
+ # A service template version status message.
3074
+ # @return [String]
3075
+ #
3076
+ # @!attribute [rw] template_name
3077
+ # The name of the version of a service template.
3078
+ # @return [String]
3079
+ #
3080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplateVersion AWS API Documentation
3081
+ #
3082
+ class ServiceTemplateVersion < Struct.new(
3083
+ :arn,
3084
+ :compatible_environment_templates,
3085
+ :created_at,
3086
+ :description,
3087
+ :last_modified_at,
3088
+ :major_version,
3089
+ :minor_version,
3090
+ :recommended_minor_version,
3091
+ :schema,
3092
+ :status,
3093
+ :status_message,
3094
+ :template_name)
3095
+ SENSITIVE = [:description, :schema, :status_message]
3096
+ include Aws::Structure
3097
+ end
3098
+
3099
+ # A summary of the service template version detail data.
3100
+ #
3101
+ # @!attribute [rw] arn
3102
+ # The Amazon Resource Name (ARN) of the version of a service template.
3103
+ # @return [String]
3104
+ #
3105
+ # @!attribute [rw] created_at
3106
+ # The time when the version of a service template was created.
3107
+ # @return [Time]
3108
+ #
3109
+ # @!attribute [rw] description
3110
+ # A description of the version of a service template.
3111
+ # @return [String]
3112
+ #
3113
+ # @!attribute [rw] last_modified_at
3114
+ # The time when the version of a service template was last modified.
3115
+ # @return [Time]
3116
+ #
3117
+ # @!attribute [rw] major_version
3118
+ # The ID of the latest major version that's associated with the
3119
+ # version of a service template.
3120
+ # @return [String]
3121
+ #
3122
+ # @!attribute [rw] minor_version
3123
+ # The ID of the minor version of a service template.
3124
+ # @return [String]
3125
+ #
3126
+ # @!attribute [rw] recommended_minor_version
3127
+ # The ID of the recommended minor version of the service template.
3128
+ # @return [String]
3129
+ #
3130
+ # @!attribute [rw] status
3131
+ # The service template minor version status.
3132
+ # @return [String]
3133
+ #
3134
+ # @!attribute [rw] status_message
3135
+ # A service template minor version status message.
3136
+ # @return [String]
3137
+ #
3138
+ # @!attribute [rw] template_name
3139
+ # The name of the service template.
3140
+ # @return [String]
3141
+ #
3142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ServiceTemplateVersionSummary AWS API Documentation
3143
+ #
3144
+ class ServiceTemplateVersionSummary < Struct.new(
3145
+ :arn,
3146
+ :created_at,
3147
+ :description,
3148
+ :last_modified_at,
3149
+ :major_version,
3150
+ :minor_version,
3151
+ :recommended_minor_version,
3152
+ :status,
3153
+ :status_message,
3154
+ :template_name)
3155
+ SENSITIVE = [:description, :status_message]
3156
+ include Aws::Structure
3157
+ end
3158
+
3159
+ # A description of a resource tag.
3160
+ #
3161
+ # @note When making an API call, you may pass Tag
3162
+ # data as a hash:
3163
+ #
3164
+ # {
3165
+ # key: "TagKey", # required
3166
+ # value: "TagValue", # required
3167
+ # }
3168
+ #
3169
+ # @!attribute [rw] key
3170
+ # The key of the resource tag.
3171
+ # @return [String]
3172
+ #
3173
+ # @!attribute [rw] value
3174
+ # The value of the resource tag.
3175
+ # @return [String]
3176
+ #
3177
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/Tag AWS API Documentation
3178
+ #
3179
+ class Tag < Struct.new(
3180
+ :key,
3181
+ :value)
3182
+ SENSITIVE = []
3183
+ include Aws::Structure
3184
+ end
3185
+
3186
+ # @note When making an API call, you may pass TagResourceInput
3187
+ # data as a hash:
3188
+ #
3189
+ # {
3190
+ # resource_arn: "Arn", # required
3191
+ # tags: [ # required
3192
+ # {
3193
+ # key: "TagKey", # required
3194
+ # value: "TagValue", # required
3195
+ # },
3196
+ # ],
3197
+ # }
3198
+ #
3199
+ # @!attribute [rw] resource_arn
3200
+ # The Amazon Resource Name (ARN) of the resource that the resource tag
3201
+ # is applied to.
3202
+ # @return [String]
3203
+ #
3204
+ # @!attribute [rw] tags
3205
+ # An array of resource tags to apply to a resource.
3206
+ # @return [Array<Types::Tag>]
3207
+ #
3208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TagResourceInput AWS API Documentation
3209
+ #
3210
+ class TagResourceInput < Struct.new(
3211
+ :resource_arn,
3212
+ :tags)
3213
+ SENSITIVE = []
3214
+ include Aws::Structure
3215
+ end
3216
+
3217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TagResourceOutput AWS API Documentation
3218
+ #
3219
+ class TagResourceOutput < Aws::EmptyStructure; end
3220
+
3221
+ # Template version source data.
3222
+ #
3223
+ # @note When making an API call, you may pass TemplateVersionSourceInput
3224
+ # data as a hash:
3225
+ #
3226
+ # {
3227
+ # s3: {
3228
+ # bucket: "S3Bucket", # required
3229
+ # key: "S3Key", # required
3230
+ # },
3231
+ # }
3232
+ #
3233
+ # @!attribute [rw] s3
3234
+ # An S3 source object that includes the template bundle S3 path and
3235
+ # name for a template minor version.
3236
+ # @return [Types::S3ObjectSource]
3237
+ #
3238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TemplateVersionSourceInput AWS API Documentation
3239
+ #
3240
+ class TemplateVersionSourceInput < Struct.new(
3241
+ :s3)
3242
+ SENSITIVE = []
3243
+ include Aws::Structure
3244
+ end
3245
+
3246
+ # The request was denied due to request throttling.
3247
+ #
3248
+ # @!attribute [rw] message
3249
+ # @return [String]
3250
+ #
3251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ThrottlingException AWS API Documentation
3252
+ #
3253
+ class ThrottlingException < Struct.new(
3254
+ :message)
3255
+ SENSITIVE = [:message]
3256
+ include Aws::Structure
3257
+ end
3258
+
3259
+ # @note When making an API call, you may pass UntagResourceInput
3260
+ # data as a hash:
3261
+ #
3262
+ # {
3263
+ # resource_arn: "Arn", # required
3264
+ # tag_keys: ["TagKey"], # required
3265
+ # }
3266
+ #
3267
+ # @!attribute [rw] resource_arn
3268
+ # The Amazon Resource Name (ARN) of the resource that the tag is to be
3269
+ # removed from.
3270
+ # @return [String]
3271
+ #
3272
+ # @!attribute [rw] tag_keys
3273
+ # An array of tag keys indicating the resource tags to be removed from
3274
+ # the resource.
3275
+ # @return [Array<String>]
3276
+ #
3277
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UntagResourceInput AWS API Documentation
3278
+ #
3279
+ class UntagResourceInput < Struct.new(
3280
+ :resource_arn,
3281
+ :tag_keys)
3282
+ SENSITIVE = []
3283
+ include Aws::Structure
3284
+ end
3285
+
3286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UntagResourceOutput AWS API Documentation
3287
+ #
3288
+ class UntagResourceOutput < Aws::EmptyStructure; end
3289
+
3290
+ # @note When making an API call, you may pass UpdateAccountSettingsInput
3291
+ # data as a hash:
3292
+ #
3293
+ # {
3294
+ # pipeline_service_role_arn: "Arn",
3295
+ # }
3296
+ #
3297
+ # @!attribute [rw] pipeline_service_role_arn
3298
+ # The Amazon Resource Name (ARN) of the AWS Proton pipeline service
3299
+ # role.
3300
+ # @return [String]
3301
+ #
3302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateAccountSettingsInput AWS API Documentation
3303
+ #
3304
+ class UpdateAccountSettingsInput < Struct.new(
3305
+ :pipeline_service_role_arn)
3306
+ SENSITIVE = []
3307
+ include Aws::Structure
3308
+ end
3309
+
3310
+ # @!attribute [rw] account_settings
3311
+ # The AWS Proton pipeline service role detail data that's returned by
3312
+ # AWS Proton.
3313
+ # @return [Types::AccountSettings]
3314
+ #
3315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateAccountSettingsOutput AWS API Documentation
3316
+ #
3317
+ class UpdateAccountSettingsOutput < Struct.new(
3318
+ :account_settings)
3319
+ SENSITIVE = []
3320
+ include Aws::Structure
3321
+ end
3322
+
3323
+ # @note When making an API call, you may pass UpdateEnvironmentAccountConnectionInput
3324
+ # data as a hash:
3325
+ #
3326
+ # {
3327
+ # id: "EnvironmentAccountConnectionId", # required
3328
+ # role_arn: "Arn", # required
3329
+ # }
3330
+ #
3331
+ # @!attribute [rw] id
3332
+ # The ID of the environment account connection to update.
3333
+ # @return [String]
3334
+ #
3335
+ # @!attribute [rw] role_arn
3336
+ # The Amazon Resource Name (ARN) of the IAM service role that is
3337
+ # associated with the environment account connection to update.
3338
+ # @return [String]
3339
+ #
3340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentAccountConnectionInput AWS API Documentation
3341
+ #
3342
+ class UpdateEnvironmentAccountConnectionInput < Struct.new(
3343
+ :id,
3344
+ :role_arn)
3345
+ SENSITIVE = []
3346
+ include Aws::Structure
3347
+ end
3348
+
3349
+ # @!attribute [rw] environment_account_connection
3350
+ # The environment account connection detail data that's returned by
3351
+ # AWS Proton.
3352
+ # @return [Types::EnvironmentAccountConnection]
3353
+ #
3354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentAccountConnectionOutput AWS API Documentation
3355
+ #
3356
+ class UpdateEnvironmentAccountConnectionOutput < Struct.new(
3357
+ :environment_account_connection)
3358
+ SENSITIVE = []
3359
+ include Aws::Structure
3360
+ end
3361
+
3362
+ # @note When making an API call, you may pass UpdateEnvironmentInput
3363
+ # data as a hash:
3364
+ #
3365
+ # {
3366
+ # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
3367
+ # description: "Description",
3368
+ # environment_account_connection_id: "EnvironmentAccountConnectionId",
3369
+ # name: "ResourceName", # required
3370
+ # proton_service_role_arn: "Arn",
3371
+ # spec: "SpecContents",
3372
+ # template_major_version: "TemplateVersionPart",
3373
+ # template_minor_version: "TemplateVersionPart",
3374
+ # }
3375
+ #
3376
+ # @!attribute [rw] deployment_type
3377
+ # There are four modes for updating an environment as described in the
3378
+ # following. The `deploymentType` field defines the mode.
3379
+ #
3380
+ #
3381
+ #
3382
+ # : `NONE`
3383
+ #
3384
+ # In this mode, a deployment *doesn't* occur. Only the requested
3385
+ # metadata parameters are updated.
3386
+ #
3387
+ #
3388
+ #
3389
+ # : `CURRENT_VERSION`
3390
+ #
3391
+ # In this mode, the environment is deployed and updated with the new
3392
+ # spec that you provide. Only requested parameters are updated.
3393
+ # *Don’t* include minor or major version parameters when you use
3394
+ # this `deployment-type`.
3395
+ #
3396
+ #
3397
+ #
3398
+ # : `MINOR_VERSION`
3399
+ #
3400
+ # In this mode, the environment is deployed and updated with the
3401
+ # published, recommended (latest) minor version of the current major
3402
+ # version in use, by default. You can also specify a different minor
3403
+ # version of the current major version in use.
3404
+ #
3405
+ #
3406
+ #
3407
+ # : `MAJOR_VERSION`
3408
+ #
3409
+ # In this mode, the environment is deployed and updated with the
3410
+ # published, recommended (latest) major and minor version of the
3411
+ # current template, by default. You can also specify a different
3412
+ # major version that is higher than the major version in use and a
3413
+ # minor version (optional).
3414
+ # @return [String]
3415
+ #
3416
+ # @!attribute [rw] description
3417
+ # A description of the environment update.
3418
+ # @return [String]
3419
+ #
3420
+ # @!attribute [rw] environment_account_connection_id
3421
+ # The ID of the environment account connection.
3422
+ #
3423
+ # You can only update to a new environment account connection if it
3424
+ # was created in the same environment account that the current
3425
+ # environment account connection was created in and associated with
3426
+ # the current environment.
3427
+ # @return [String]
3428
+ #
3429
+ # @!attribute [rw] name
3430
+ # The name of the environment to update.
3431
+ # @return [String]
3432
+ #
3433
+ # @!attribute [rw] proton_service_role_arn
3434
+ # The ARN of the AWS Proton service role that allows AWS Proton to
3435
+ # make API calls to other services your behalf.
3436
+ # @return [String]
3437
+ #
3438
+ # @!attribute [rw] spec
3439
+ # The formatted specification that defines the update.
3440
+ # @return [String]
3441
+ #
3442
+ # @!attribute [rw] template_major_version
3443
+ # The ID of the major version of the environment to update.
3444
+ # @return [String]
3445
+ #
3446
+ # @!attribute [rw] template_minor_version
3447
+ # The ID of the minor version of the environment to update.
3448
+ # @return [String]
3449
+ #
3450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentInput AWS API Documentation
3451
+ #
3452
+ class UpdateEnvironmentInput < Struct.new(
3453
+ :deployment_type,
3454
+ :description,
3455
+ :environment_account_connection_id,
3456
+ :name,
3457
+ :proton_service_role_arn,
3458
+ :spec,
3459
+ :template_major_version,
3460
+ :template_minor_version)
3461
+ SENSITIVE = [:description, :spec]
3462
+ include Aws::Structure
3463
+ end
3464
+
3465
+ # @!attribute [rw] environment
3466
+ # The environment detail data that's returned by AWS Proton.
3467
+ # @return [Types::Environment]
3468
+ #
3469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentOutput AWS API Documentation
3470
+ #
3471
+ class UpdateEnvironmentOutput < Struct.new(
3472
+ :environment)
3473
+ SENSITIVE = []
3474
+ include Aws::Structure
3475
+ end
3476
+
3477
+ # @note When making an API call, you may pass UpdateEnvironmentTemplateInput
3478
+ # data as a hash:
3479
+ #
3480
+ # {
3481
+ # description: "Description",
3482
+ # display_name: "DisplayName",
3483
+ # name: "ResourceName", # required
3484
+ # }
3485
+ #
3486
+ # @!attribute [rw] description
3487
+ # A description of the environment template update.
3488
+ # @return [String]
3489
+ #
3490
+ # @!attribute [rw] display_name
3491
+ # The name of the environment template to update as displayed in the
3492
+ # developer interface.
3493
+ # @return [String]
3494
+ #
3495
+ # @!attribute [rw] name
3496
+ # The name of the environment template to update.
3497
+ # @return [String]
3498
+ #
3499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateInput AWS API Documentation
3500
+ #
3501
+ class UpdateEnvironmentTemplateInput < Struct.new(
3502
+ :description,
3503
+ :display_name,
3504
+ :name)
3505
+ SENSITIVE = [:description, :display_name]
3506
+ include Aws::Structure
3507
+ end
3508
+
3509
+ # @!attribute [rw] environment_template
3510
+ # The environment template detail data that's returned by AWS Proton.
3511
+ # @return [Types::EnvironmentTemplate]
3512
+ #
3513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateOutput AWS API Documentation
3514
+ #
3515
+ class UpdateEnvironmentTemplateOutput < Struct.new(
3516
+ :environment_template)
3517
+ SENSITIVE = []
3518
+ include Aws::Structure
3519
+ end
3520
+
3521
+ # @note When making an API call, you may pass UpdateEnvironmentTemplateVersionInput
3522
+ # data as a hash:
3523
+ #
3524
+ # {
3525
+ # description: "Description",
3526
+ # major_version: "TemplateVersionPart", # required
3527
+ # minor_version: "TemplateVersionPart", # required
3528
+ # status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
3529
+ # template_name: "ResourceName", # required
3530
+ # }
3531
+ #
3532
+ # @!attribute [rw] description
3533
+ # A description of environment template version to update.
3534
+ # @return [String]
3535
+ #
3536
+ # @!attribute [rw] major_version
3537
+ # To update a major version of an environment template, include
3538
+ # `majorVersion`.
3539
+ # @return [String]
3540
+ #
3541
+ # @!attribute [rw] minor_version
3542
+ # To update a minor version of an environment template, include
3543
+ # `minorVersion`.
3544
+ # @return [String]
3545
+ #
3546
+ # @!attribute [rw] status
3547
+ # The status of the environment template minor version to update.
3548
+ # @return [String]
3549
+ #
3550
+ # @!attribute [rw] template_name
3551
+ # The name of the environment template.
3552
+ # @return [String]
3553
+ #
3554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateVersionInput AWS API Documentation
3555
+ #
3556
+ class UpdateEnvironmentTemplateVersionInput < Struct.new(
3557
+ :description,
3558
+ :major_version,
3559
+ :minor_version,
3560
+ :status,
3561
+ :template_name)
3562
+ SENSITIVE = [:description]
3563
+ include Aws::Structure
3564
+ end
3565
+
3566
+ # @!attribute [rw] environment_template_version
3567
+ # The environment template version detail data that's returned by AWS
3568
+ # Proton.
3569
+ # @return [Types::EnvironmentTemplateVersion]
3570
+ #
3571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateVersionOutput AWS API Documentation
3572
+ #
3573
+ class UpdateEnvironmentTemplateVersionOutput < Struct.new(
3574
+ :environment_template_version)
3575
+ SENSITIVE = []
3576
+ include Aws::Structure
3577
+ end
3578
+
3579
+ # @note When making an API call, you may pass UpdateServiceInput
3580
+ # data as a hash:
3581
+ #
3582
+ # {
3583
+ # description: "Description",
3584
+ # name: "ResourceName", # required
3585
+ # spec: "SpecContents",
3586
+ # }
3587
+ #
3588
+ # @!attribute [rw] description
3589
+ # The edited service description.
3590
+ # @return [String]
3591
+ #
3592
+ # @!attribute [rw] name
3593
+ # The name of the service to edit.
3594
+ # @return [String]
3595
+ #
3596
+ # @!attribute [rw] spec
3597
+ # Lists the service instances to add and the existing service
3598
+ # instances to remain. Omit the existing service instances to delete
3599
+ # from the list. *Don't* include edits to the existing service
3600
+ # instances or pipeline. For more information, see *Edit a service* in
3601
+ # the [AWS Proton Administration Guide][1] or the [AWS Proton User
3602
+ # Guide][2].
3603
+ #
3604
+ #
3605
+ #
3606
+ # [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html
3607
+ # [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html
3608
+ # @return [String]
3609
+ #
3610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInput AWS API Documentation
3611
+ #
3612
+ class UpdateServiceInput < Struct.new(
3613
+ :description,
3614
+ :name,
3615
+ :spec)
3616
+ SENSITIVE = [:description, :spec]
3617
+ include Aws::Structure
3618
+ end
3619
+
3620
+ # @note When making an API call, you may pass UpdateServiceInstanceInput
3621
+ # data as a hash:
3622
+ #
3623
+ # {
3624
+ # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
3625
+ # name: "ResourceName", # required
3626
+ # service_name: "ResourceName", # required
3627
+ # spec: "SpecContents",
3628
+ # template_major_version: "TemplateVersionPart",
3629
+ # template_minor_version: "TemplateVersionPart",
3630
+ # }
3631
+ #
3632
+ # @!attribute [rw] deployment_type
3633
+ # The deployment type.
3634
+ #
3635
+ # There are four modes for updating a service instance as described in
3636
+ # the following. The `deploymentType` field defines the mode.
3637
+ #
3638
+ #
3639
+ #
3640
+ # : `NONE`
3641
+ #
3642
+ # In this mode, a deployment *doesn't* occur. Only the requested
3643
+ # metadata parameters are updated.
3644
+ #
3645
+ #
3646
+ #
3647
+ # : `CURRENT_VERSION`
3648
+ #
3649
+ # In this mode, the service instance is deployed and updated with
3650
+ # the new spec that you provide. Only requested parameters are
3651
+ # updated. *Don’t* include minor or major version parameters when
3652
+ # you use this `deployment-type`.
3653
+ #
3654
+ #
3655
+ #
3656
+ # : `MINOR_VERSION`
3657
+ #
3658
+ # In this mode, the service instance is deployed and updated with
3659
+ # the published, recommended (latest) minor version of the current
3660
+ # major version in use, by default. You can also specify a different
3661
+ # minor version of the current major version in use.
3662
+ #
3663
+ #
3664
+ #
3665
+ # : `MAJOR_VERSION`
3666
+ #
3667
+ # In this mode, the service instance is deployed and updated with
3668
+ # the published, recommended (latest) major and minor version of the
3669
+ # current template, by default. You can also specify a different
3670
+ # major version that is higher than the major version in use and a
3671
+ # minor version (optional).
3672
+ # @return [String]
3673
+ #
3674
+ # @!attribute [rw] name
3675
+ # The name of the service instance to update.
3676
+ # @return [String]
3677
+ #
3678
+ # @!attribute [rw] service_name
3679
+ # The name of the service that the service instance belongs to.
3680
+ # @return [String]
3681
+ #
3682
+ # @!attribute [rw] spec
3683
+ # The formatted specification that defines the service instance
3684
+ # update.
3685
+ # @return [String]
3686
+ #
3687
+ # @!attribute [rw] template_major_version
3688
+ # The major version of the service template to update.
3689
+ # @return [String]
3690
+ #
3691
+ # @!attribute [rw] template_minor_version
3692
+ # The minor version of the service template to update.
3693
+ # @return [String]
3694
+ #
3695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInstanceInput AWS API Documentation
3696
+ #
3697
+ class UpdateServiceInstanceInput < Struct.new(
3698
+ :deployment_type,
3699
+ :name,
3700
+ :service_name,
3701
+ :spec,
3702
+ :template_major_version,
3703
+ :template_minor_version)
3704
+ SENSITIVE = [:spec]
3705
+ include Aws::Structure
3706
+ end
3707
+
3708
+ # @!attribute [rw] service_instance
3709
+ # The service instance summary data returned by AWS Proton.
3710
+ # @return [Types::ServiceInstance]
3711
+ #
3712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInstanceOutput AWS API Documentation
3713
+ #
3714
+ class UpdateServiceInstanceOutput < Struct.new(
3715
+ :service_instance)
3716
+ SENSITIVE = []
3717
+ include Aws::Structure
3718
+ end
3719
+
3720
+ # @!attribute [rw] service
3721
+ # The service detail data that's returned by AWS Proton.
3722
+ # @return [Types::Service]
3723
+ #
3724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceOutput AWS API Documentation
3725
+ #
3726
+ class UpdateServiceOutput < Struct.new(
3727
+ :service)
3728
+ SENSITIVE = []
3729
+ include Aws::Structure
3730
+ end
3731
+
3732
+ # @note When making an API call, you may pass UpdateServicePipelineInput
3733
+ # data as a hash:
3734
+ #
3735
+ # {
3736
+ # deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
3737
+ # service_name: "ResourceName", # required
3738
+ # spec: "SpecContents", # required
3739
+ # template_major_version: "TemplateVersionPart",
3740
+ # template_minor_version: "TemplateVersionPart",
3741
+ # }
3742
+ #
3743
+ # @!attribute [rw] deployment_type
3744
+ # The deployment type.
3745
+ #
3746
+ # There are four modes for updating a service pipeline as described in
3747
+ # the following. The `deploymentType` field defines the mode.
3748
+ #
3749
+ #
3750
+ #
3751
+ # : `NONE`
3752
+ #
3753
+ # In this mode, a deployment *doesn't* occur. Only the requested
3754
+ # metadata parameters are updated.
3755
+ #
3756
+ #
3757
+ #
3758
+ # : `CURRENT_VERSION`
3759
+ #
3760
+ # In this mode, the service pipeline is deployed and updated with
3761
+ # the new spec that you provide. Only requested parameters are
3762
+ # updated. *Don’t* include minor or major version parameters when
3763
+ # you use this `deployment-type`.
3764
+ #
3765
+ #
3766
+ #
3767
+ # : `MINOR_VERSION`
3768
+ #
3769
+ # In this mode, the service pipeline is deployed and updated with
3770
+ # the published, recommended (latest) minor version of the current
3771
+ # major version in use, by default. You can also specify a different
3772
+ # minor version of the current major version in use.
3773
+ #
3774
+ #
3775
+ #
3776
+ # : `MAJOR_VERSION`
3777
+ #
3778
+ # In this mode, the service pipeline is deployed and updated with
3779
+ # the published, recommended (latest) major and minor version of the
3780
+ # current template, by default. You can also specify a different
3781
+ # major version that is higher than the major version in use and a
3782
+ # minor version (optional).
3783
+ # @return [String]
3784
+ #
3785
+ # @!attribute [rw] service_name
3786
+ # The name of the service to that the pipeline is associated with.
3787
+ # @return [String]
3788
+ #
3789
+ # @!attribute [rw] spec
3790
+ # The spec for the service pipeline to update.
3791
+ # @return [String]
3792
+ #
3793
+ # @!attribute [rw] template_major_version
3794
+ # The major version of the service template that was used to create
3795
+ # the service that the pipeline is associated with.
3796
+ # @return [String]
3797
+ #
3798
+ # @!attribute [rw] template_minor_version
3799
+ # The minor version of the service template that was used to create
3800
+ # the service that the pipeline is associated with.
3801
+ # @return [String]
3802
+ #
3803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServicePipelineInput AWS API Documentation
3804
+ #
3805
+ class UpdateServicePipelineInput < Struct.new(
3806
+ :deployment_type,
3807
+ :service_name,
3808
+ :spec,
3809
+ :template_major_version,
3810
+ :template_minor_version)
3811
+ SENSITIVE = [:spec]
3812
+ include Aws::Structure
3813
+ end
3814
+
3815
+ # @!attribute [rw] pipeline
3816
+ # The pipeline details returned by AWS Proton.
3817
+ # @return [Types::ServicePipeline]
3818
+ #
3819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServicePipelineOutput AWS API Documentation
3820
+ #
3821
+ class UpdateServicePipelineOutput < Struct.new(
3822
+ :pipeline)
3823
+ SENSITIVE = []
3824
+ include Aws::Structure
3825
+ end
3826
+
3827
+ # @note When making an API call, you may pass UpdateServiceTemplateInput
3828
+ # data as a hash:
3829
+ #
3830
+ # {
3831
+ # description: "Description",
3832
+ # display_name: "DisplayName",
3833
+ # name: "ResourceName", # required
3834
+ # }
3835
+ #
3836
+ # @!attribute [rw] description
3837
+ # A description of the service template update.
3838
+ # @return [String]
3839
+ #
3840
+ # @!attribute [rw] display_name
3841
+ # The name of the service template to update as displayed in the
3842
+ # developer interface.
3843
+ # @return [String]
3844
+ #
3845
+ # @!attribute [rw] name
3846
+ # The name of the service template to update.
3847
+ # @return [String]
3848
+ #
3849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateInput AWS API Documentation
3850
+ #
3851
+ class UpdateServiceTemplateInput < Struct.new(
3852
+ :description,
3853
+ :display_name,
3854
+ :name)
3855
+ SENSITIVE = [:description, :display_name]
3856
+ include Aws::Structure
3857
+ end
3858
+
3859
+ # @!attribute [rw] service_template
3860
+ # The service template detail data that's returned by AWS Proton.
3861
+ # @return [Types::ServiceTemplate]
3862
+ #
3863
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateOutput AWS API Documentation
3864
+ #
3865
+ class UpdateServiceTemplateOutput < Struct.new(
3866
+ :service_template)
3867
+ SENSITIVE = []
3868
+ include Aws::Structure
3869
+ end
3870
+
3871
+ # @note When making an API call, you may pass UpdateServiceTemplateVersionInput
3872
+ # data as a hash:
3873
+ #
3874
+ # {
3875
+ # compatible_environment_templates: [
3876
+ # {
3877
+ # major_version: "TemplateVersionPart", # required
3878
+ # template_name: "ResourceName", # required
3879
+ # },
3880
+ # ],
3881
+ # description: "Description",
3882
+ # major_version: "TemplateVersionPart", # required
3883
+ # minor_version: "TemplateVersionPart", # required
3884
+ # status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
3885
+ # template_name: "ResourceName", # required
3886
+ # }
3887
+ #
3888
+ # @!attribute [rw] compatible_environment_templates
3889
+ # An array of compatible environment names for a service template
3890
+ # major or minor version to update.
3891
+ # @return [Array<Types::CompatibleEnvironmentTemplateInput>]
3892
+ #
3893
+ # @!attribute [rw] description
3894
+ # A description of a service template version to update.
3895
+ # @return [String]
3896
+ #
3897
+ # @!attribute [rw] major_version
3898
+ # To update a major version of a service template, include
3899
+ # `majorVersion`.
3900
+ # @return [String]
3901
+ #
3902
+ # @!attribute [rw] minor_version
3903
+ # To update a minor version of a service template, include
3904
+ # `minorVersion`.
3905
+ # @return [String]
3906
+ #
3907
+ # @!attribute [rw] status
3908
+ # The status of the service template minor version to update.
3909
+ # @return [String]
3910
+ #
3911
+ # @!attribute [rw] template_name
3912
+ # The name of the service template.
3913
+ # @return [String]
3914
+ #
3915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersionInput AWS API Documentation
3916
+ #
3917
+ class UpdateServiceTemplateVersionInput < Struct.new(
3918
+ :compatible_environment_templates,
3919
+ :description,
3920
+ :major_version,
3921
+ :minor_version,
3922
+ :status,
3923
+ :template_name)
3924
+ SENSITIVE = [:description]
3925
+ include Aws::Structure
3926
+ end
3927
+
3928
+ # @!attribute [rw] service_template_version
3929
+ # The service template version detail data that's returned by AWS
3930
+ # Proton.
3931
+ # @return [Types::ServiceTemplateVersion]
3932
+ #
3933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersionOutput AWS API Documentation
3934
+ #
3935
+ class UpdateServiceTemplateVersionOutput < Struct.new(
3936
+ :service_template_version)
3937
+ SENSITIVE = []
3938
+ include Aws::Structure
3939
+ end
3940
+
3941
+ # The input is invalid or an out-of-range value was supplied for the
3942
+ # input parameter.
3943
+ #
3944
+ # @!attribute [rw] message
3945
+ # @return [String]
3946
+ #
3947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ValidationException AWS API Documentation
3948
+ #
3949
+ class ValidationException < Struct.new(
3950
+ :message)
3951
+ SENSITIVE = [:message]
3952
+ include Aws::Structure
3953
+ end
3954
+
3955
+ end
3956
+ end