aws-sdk-proton 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-proton.rb +53 -0
- data/lib/aws-sdk-proton/client.rb +3389 -0
- data/lib/aws-sdk-proton/client_api.rb +1636 -0
- data/lib/aws-sdk-proton/customizations.rb +0 -0
- data/lib/aws-sdk-proton/errors.rb +162 -0
- data/lib/aws-sdk-proton/resource.rb +26 -0
- data/lib/aws-sdk-proton/types.rb +3956 -0
- metadata +90 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 72bd27242b366b260531c5db225966fa7c884cbc5c11177889cc41862f6115bb
|
4
|
+
data.tar.gz: 14485e3ecc45a0c019ee3cbf836c991504a0b3d9c3a059db5a05fce5b40cbb40
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: '058f1387af421e8b26b3cb09423cf722a7194fb093fb23891603a0652290deac1fc21b02d5d300fdb26e6308a85deb5212a4b305b6529e083362d460e1f1e96b'
|
7
|
+
data.tar.gz: 1ac1a0a5df9a36c89b14b7680667dca610a8f82a771dfd2ef12fd0f31df1535df8125fec3219c731176e7ac0ae41c45561355537864dd9c4914f7f850b1b46ee
|
data/CHANGELOG.md
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.0.0
|
@@ -0,0 +1,53 @@
|
|
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
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-proton/types'
|
15
|
+
require_relative 'aws-sdk-proton/client_api'
|
16
|
+
require_relative 'aws-sdk-proton/client'
|
17
|
+
require_relative 'aws-sdk-proton/errors'
|
18
|
+
require_relative 'aws-sdk-proton/resource'
|
19
|
+
require_relative 'aws-sdk-proton/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AWS Proton. This module is available in the
|
22
|
+
# `aws-sdk-proton` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# proton = Aws::Proton::Client.new
|
31
|
+
# resp = proton.accept_environment_account_connection(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AWS Proton are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::Proton::Errors::ServiceError
|
43
|
+
# # rescues all AWS Proton API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::Proton
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,3389 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:proton)
|
34
|
+
|
35
|
+
module Aws::Proton
|
36
|
+
# An API client for Proton. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::Proton::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :proton
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
102
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
103
|
+
# from an EC2 IMDS on an EC2 instance.
|
104
|
+
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
107
|
+
#
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
110
|
+
#
|
111
|
+
# When `:credentials` are not configured directly, the following
|
112
|
+
# locations will be searched for credentials:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:credentials]`
|
115
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
116
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
117
|
+
# * `~/.aws/credentials`
|
118
|
+
# * `~/.aws/config`
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
123
|
+
#
|
124
|
+
# @option options [required, String] :region
|
125
|
+
# The AWS region to connect to. The configured `:region` is
|
126
|
+
# used to determine the service `:endpoint`. When not passed,
|
127
|
+
# a default `:region` is searched for in the following locations:
|
128
|
+
#
|
129
|
+
# * `Aws.config[:region]`
|
130
|
+
# * `ENV['AWS_REGION']`
|
131
|
+
# * `ENV['AMAZON_REGION']`
|
132
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
133
|
+
# * `~/.aws/credentials`
|
134
|
+
# * `~/.aws/config`
|
135
|
+
#
|
136
|
+
# @option options [String] :access_key_id
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
139
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
140
|
+
# the background every 60 secs (default). Defaults to `false`.
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
143
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
144
|
+
# until there is sufficent client side capacity to retry the request.
|
145
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
146
|
+
# not retry instead of sleeping.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
149
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
150
|
+
# this client.
|
151
|
+
#
|
152
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
153
|
+
# Allows you to provide an identifier for this client which will be attached to
|
154
|
+
# all generated client side metrics. Defaults to an empty string.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
157
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
158
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
159
|
+
#
|
160
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
161
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
162
|
+
# agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
165
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
166
|
+
# will use the Client Side Monitoring Agent Publisher.
|
167
|
+
#
|
168
|
+
# @option options [Boolean] :convert_params (true)
|
169
|
+
# When `true`, an attempt is made to coerce request parameters into
|
170
|
+
# the required types.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
173
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
|
+
# Set to true to disable SDK automatically adding host prefix
|
178
|
+
# to default service endpoint when available.
|
179
|
+
#
|
180
|
+
# @option options [String] :endpoint
|
181
|
+
# The client endpoint is normally constructed from the `:region`
|
182
|
+
# option. You should only configure an `:endpoint` when connecting
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
184
|
+
#
|
185
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
186
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
187
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
188
|
+
#
|
189
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
190
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
191
|
+
#
|
192
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
193
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
194
|
+
# Use this option to config the time interval in seconds for making
|
195
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
196
|
+
#
|
197
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
198
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
199
|
+
#
|
200
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
201
|
+
# The log formatter.
|
202
|
+
#
|
203
|
+
# @option options [Symbol] :log_level (:info)
|
204
|
+
# The log level to send messages to the `:logger` at.
|
205
|
+
#
|
206
|
+
# @option options [Logger] :logger
|
207
|
+
# The Logger instance to send log messages to. If this option
|
208
|
+
# is not set, logging will be disabled.
|
209
|
+
#
|
210
|
+
# @option options [Integer] :max_attempts (3)
|
211
|
+
# An integer representing the maximum number attempts that will be made for
|
212
|
+
# a single request, including the initial attempt. For example,
|
213
|
+
# setting this value to 5 will result in a request being retried up to
|
214
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
215
|
+
#
|
216
|
+
# @option options [String] :profile ("default")
|
217
|
+
# Used when loading credentials from the shared credentials file
|
218
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
219
|
+
#
|
220
|
+
# @option options [Proc] :retry_backoff
|
221
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
222
|
+
# This option is only used in the `legacy` retry mode.
|
223
|
+
#
|
224
|
+
# @option options [Float] :retry_base_delay (0.3)
|
225
|
+
# The base delay in seconds used by the default backoff function. This option
|
226
|
+
# is only used in the `legacy` retry mode.
|
227
|
+
#
|
228
|
+
# @option options [Symbol] :retry_jitter (:none)
|
229
|
+
# A delay randomiser function used by the default backoff function.
|
230
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
231
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
232
|
+
# in the `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
235
|
+
#
|
236
|
+
# @option options [Integer] :retry_limit (3)
|
237
|
+
# The maximum number of times to retry failed requests. Only
|
238
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
239
|
+
# are retried. Generally, these are throttling errors, data
|
240
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
241
|
+
# endpoint discovery, and errors from expired credentials.
|
242
|
+
# This option is only used in the `legacy` retry mode.
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_max_delay (0)
|
245
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
246
|
+
# used by the default backoff function. This option is only used in the
|
247
|
+
# `legacy` retry mode.
|
248
|
+
#
|
249
|
+
# @option options [String] :retry_mode ("legacy")
|
250
|
+
# Specifies which retry algorithm to use. Values are:
|
251
|
+
#
|
252
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
253
|
+
# no retry mode is provided.
|
254
|
+
#
|
255
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
256
|
+
# This includes support for retry quotas, which limit the number of
|
257
|
+
# unsuccessful retries a client can make.
|
258
|
+
#
|
259
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
260
|
+
# functionality of `standard` mode along with automatic client side
|
261
|
+
# throttling. This is a provisional mode that may change behavior
|
262
|
+
# in the future.
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# @option options [String] :secret_access_key
|
266
|
+
#
|
267
|
+
# @option options [String] :session_token
|
268
|
+
#
|
269
|
+
# @option options [Boolean] :simple_json (false)
|
270
|
+
# Disables request parameter conversion, validation, and formatting.
|
271
|
+
# Also disable response data type conversions. This option is useful
|
272
|
+
# when you want to ensure the highest level of performance by
|
273
|
+
# avoiding overhead of walking request parameters and response data
|
274
|
+
# structures.
|
275
|
+
#
|
276
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
277
|
+
# be formatted exactly as the DynamoDB API expects.
|
278
|
+
#
|
279
|
+
# @option options [Boolean] :stub_responses (false)
|
280
|
+
# Causes the client to return stubbed responses. By default
|
281
|
+
# fake responses are generated and returned. You can specify
|
282
|
+
# the response data to return or errors to raise by calling
|
283
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
284
|
+
#
|
285
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
|
+
# requests are made, and retries are disabled.
|
287
|
+
#
|
288
|
+
# @option options [Boolean] :validate_params (true)
|
289
|
+
# When `true`, request parameters are validated before
|
290
|
+
# sending the request.
|
291
|
+
#
|
292
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
293
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
294
|
+
#
|
295
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
296
|
+
# seconds to wait when opening a HTTP session before raising a
|
297
|
+
# `Timeout::Error`.
|
298
|
+
#
|
299
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
300
|
+
# number of seconds to wait for response data. This value can
|
301
|
+
# safely be set per-request on the session.
|
302
|
+
#
|
303
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
304
|
+
# seconds a connection is allowed to sit idle before it is
|
305
|
+
# considered stale. Stale connections are closed and removed
|
306
|
+
# from the pool before making a request.
|
307
|
+
#
|
308
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
309
|
+
# seconds to wait for a 100-continue response before sending the
|
310
|
+
# request body. This option has no effect unless the request has
|
311
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
312
|
+
# disables this behaviour. This value can safely be set per
|
313
|
+
# request on the session.
|
314
|
+
#
|
315
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
|
+
# HTTP debug output will be sent to the `:logger`.
|
317
|
+
#
|
318
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
319
|
+
# SSL peer certificates are verified when establishing a
|
320
|
+
# connection.
|
321
|
+
#
|
322
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
323
|
+
# certificate authority bundle file that should be used when
|
324
|
+
# verifying peer certificates. If you do not pass
|
325
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
326
|
+
# will be used if available.
|
327
|
+
#
|
328
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
329
|
+
# directory that contains the unbundled SSL certificate
|
330
|
+
# authority files for verifying peer certificates. If you do
|
331
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
332
|
+
# system default will be used if available.
|
333
|
+
#
|
334
|
+
def initialize(*args)
|
335
|
+
super
|
336
|
+
end
|
337
|
+
|
338
|
+
# @!group API Operations
|
339
|
+
|
340
|
+
# In a management account, an environment account connection request is
|
341
|
+
# accepted. When the environment account connection request is accepted,
|
342
|
+
# AWS Proton can use the associated IAM role to provision environment
|
343
|
+
# infrastructure resources in the associated environment account.
|
344
|
+
#
|
345
|
+
# For more information, see [Environment account
|
346
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
347
|
+
# in the *AWS Proton Administration guide*.
|
348
|
+
#
|
349
|
+
# @option params [required, String] :id
|
350
|
+
# The ID of the environment account connection.
|
351
|
+
#
|
352
|
+
# @return [Types::AcceptEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
353
|
+
#
|
354
|
+
# * {Types::AcceptEnvironmentAccountConnectionOutput#environment_account_connection #environment_account_connection} => Types::EnvironmentAccountConnection
|
355
|
+
#
|
356
|
+
# @example Request syntax with placeholder values
|
357
|
+
#
|
358
|
+
# resp = client.accept_environment_account_connection({
|
359
|
+
# id: "EnvironmentAccountConnectionId", # required
|
360
|
+
# })
|
361
|
+
#
|
362
|
+
# @example Response structure
|
363
|
+
#
|
364
|
+
# resp.environment_account_connection.arn #=> String
|
365
|
+
# resp.environment_account_connection.environment_account_id #=> String
|
366
|
+
# resp.environment_account_connection.environment_name #=> String
|
367
|
+
# resp.environment_account_connection.id #=> String
|
368
|
+
# resp.environment_account_connection.last_modified_at #=> Time
|
369
|
+
# resp.environment_account_connection.management_account_id #=> String
|
370
|
+
# resp.environment_account_connection.requested_at #=> Time
|
371
|
+
# resp.environment_account_connection.role_arn #=> String
|
372
|
+
# resp.environment_account_connection.status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
373
|
+
#
|
374
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/AcceptEnvironmentAccountConnection AWS API Documentation
|
375
|
+
#
|
376
|
+
# @overload accept_environment_account_connection(params = {})
|
377
|
+
# @param [Hash] params ({})
|
378
|
+
def accept_environment_account_connection(params = {}, options = {})
|
379
|
+
req = build_request(:accept_environment_account_connection, params)
|
380
|
+
req.send_request(options)
|
381
|
+
end
|
382
|
+
|
383
|
+
# Attempts to cancel an environment deployment on an UpdateEnvironment
|
384
|
+
# action, if the deployment is `IN_PROGRESS`. For more information, see
|
385
|
+
# [Update an environment][1] in the *AWS Proton Administration guide*.
|
386
|
+
#
|
387
|
+
# The following list includes potential cancellation scenarios.
|
388
|
+
#
|
389
|
+
# * If the cancellation attempt succeeds, the resulting deployment state
|
390
|
+
# is `CANCELLED`.
|
391
|
+
#
|
392
|
+
# * If the cancellation attempt fails, the resulting deployment state is
|
393
|
+
# `FAILED`.
|
394
|
+
#
|
395
|
+
# * If the current UpdateEnvironment action succeeds before the
|
396
|
+
# cancellation attempt starts, the resulting deployment state is
|
397
|
+
# `SUCCEEDED` and the cancellation attempt has no effect.
|
398
|
+
#
|
399
|
+
#
|
400
|
+
#
|
401
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-update.html
|
402
|
+
#
|
403
|
+
# @option params [required, String] :environment_name
|
404
|
+
# The name of the environment with the deployment to cancel.
|
405
|
+
#
|
406
|
+
# @return [Types::CancelEnvironmentDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
407
|
+
#
|
408
|
+
# * {Types::CancelEnvironmentDeploymentOutput#environment #environment} => Types::Environment
|
409
|
+
#
|
410
|
+
# @example Request syntax with placeholder values
|
411
|
+
#
|
412
|
+
# resp = client.cancel_environment_deployment({
|
413
|
+
# environment_name: "ResourceName", # required
|
414
|
+
# })
|
415
|
+
#
|
416
|
+
# @example Response structure
|
417
|
+
#
|
418
|
+
# resp.environment.arn #=> String
|
419
|
+
# resp.environment.created_at #=> Time
|
420
|
+
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
421
|
+
# resp.environment.deployment_status_message #=> String
|
422
|
+
# resp.environment.description #=> String
|
423
|
+
# resp.environment.environment_account_connection_id #=> String
|
424
|
+
# resp.environment.environment_account_id #=> String
|
425
|
+
# resp.environment.last_deployment_attempted_at #=> Time
|
426
|
+
# resp.environment.last_deployment_succeeded_at #=> Time
|
427
|
+
# resp.environment.name #=> String
|
428
|
+
# resp.environment.proton_service_role_arn #=> String
|
429
|
+
# resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
430
|
+
# resp.environment.spec #=> String
|
431
|
+
# resp.environment.template_major_version #=> String
|
432
|
+
# resp.environment.template_minor_version #=> String
|
433
|
+
# resp.environment.template_name #=> String
|
434
|
+
#
|
435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelEnvironmentDeployment AWS API Documentation
|
436
|
+
#
|
437
|
+
# @overload cancel_environment_deployment(params = {})
|
438
|
+
# @param [Hash] params ({})
|
439
|
+
def cancel_environment_deployment(params = {}, options = {})
|
440
|
+
req = build_request(:cancel_environment_deployment, params)
|
441
|
+
req.send_request(options)
|
442
|
+
end
|
443
|
+
|
444
|
+
# Attempts to cancel a service instance deployment on an
|
445
|
+
# UpdateServiceInstance action, if the deployment is `IN_PROGRESS`. For
|
446
|
+
# more information, see *Update a service instance* in the [AWS Proton
|
447
|
+
# Administration guide][1] or the [AWS Proton User guide][2].
|
448
|
+
#
|
449
|
+
# The following list includes potential cancellation scenarios.
|
450
|
+
#
|
451
|
+
# * If the cancellation attempt succeeds, the resulting deployment state
|
452
|
+
# is `CANCELLED`.
|
453
|
+
#
|
454
|
+
# * If the cancellation attempt fails, the resulting deployment state is
|
455
|
+
# `FAILED`.
|
456
|
+
#
|
457
|
+
# * If the current UpdateServiceInstance action succeeds before the
|
458
|
+
# cancellation attempt starts, the resulting deployment state is
|
459
|
+
# `SUCCEEDED` and the cancellation attempt has no effect.
|
460
|
+
#
|
461
|
+
#
|
462
|
+
#
|
463
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html
|
464
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html
|
465
|
+
#
|
466
|
+
# @option params [required, String] :service_instance_name
|
467
|
+
# The name of the service instance with the deployment to cancel.
|
468
|
+
#
|
469
|
+
# @option params [required, String] :service_name
|
470
|
+
# The name of the service with the service instance deployment to
|
471
|
+
# cancel.
|
472
|
+
#
|
473
|
+
# @return [Types::CancelServiceInstanceDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
474
|
+
#
|
475
|
+
# * {Types::CancelServiceInstanceDeploymentOutput#service_instance #service_instance} => Types::ServiceInstance
|
476
|
+
#
|
477
|
+
# @example Request syntax with placeholder values
|
478
|
+
#
|
479
|
+
# resp = client.cancel_service_instance_deployment({
|
480
|
+
# service_instance_name: "ResourceName", # required
|
481
|
+
# service_name: "ResourceName", # required
|
482
|
+
# })
|
483
|
+
#
|
484
|
+
# @example Response structure
|
485
|
+
#
|
486
|
+
# resp.service_instance.arn #=> String
|
487
|
+
# resp.service_instance.created_at #=> Time
|
488
|
+
# resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
489
|
+
# resp.service_instance.deployment_status_message #=> String
|
490
|
+
# resp.service_instance.environment_name #=> String
|
491
|
+
# resp.service_instance.last_deployment_attempted_at #=> Time
|
492
|
+
# resp.service_instance.last_deployment_succeeded_at #=> Time
|
493
|
+
# resp.service_instance.name #=> String
|
494
|
+
# resp.service_instance.service_name #=> String
|
495
|
+
# resp.service_instance.spec #=> String
|
496
|
+
# resp.service_instance.template_major_version #=> String
|
497
|
+
# resp.service_instance.template_minor_version #=> String
|
498
|
+
# resp.service_instance.template_name #=> String
|
499
|
+
#
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServiceInstanceDeployment AWS API Documentation
|
501
|
+
#
|
502
|
+
# @overload cancel_service_instance_deployment(params = {})
|
503
|
+
# @param [Hash] params ({})
|
504
|
+
def cancel_service_instance_deployment(params = {}, options = {})
|
505
|
+
req = build_request(:cancel_service_instance_deployment, params)
|
506
|
+
req.send_request(options)
|
507
|
+
end
|
508
|
+
|
509
|
+
# Attempts to cancel a service pipeline deployment on an
|
510
|
+
# UpdateServicePipeline action, if the deployment is `IN_PROGRESS`. For
|
511
|
+
# more information, see *Update a service pipeline* in the [AWS Proton
|
512
|
+
# Administration guide][1] or the [AWS Proton User guide][2].
|
513
|
+
#
|
514
|
+
# The following list includes potential cancellation scenarios.
|
515
|
+
#
|
516
|
+
# * If the cancellation attempt succeeds, the resulting deployment state
|
517
|
+
# is `CANCELLED`.
|
518
|
+
#
|
519
|
+
# * If the cancellation attempt fails, the resulting deployment state is
|
520
|
+
# `FAILED`.
|
521
|
+
#
|
522
|
+
# * If the current UpdateServicePipeline action succeeds before the
|
523
|
+
# cancellation attempt starts, the resulting deployment state is
|
524
|
+
# `SUCCEEDED` and the cancellation attempt has no effect.
|
525
|
+
#
|
526
|
+
#
|
527
|
+
#
|
528
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html
|
529
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html
|
530
|
+
#
|
531
|
+
# @option params [required, String] :service_name
|
532
|
+
# The name of the service with the service pipeline deployment to
|
533
|
+
# cancel.
|
534
|
+
#
|
535
|
+
# @return [Types::CancelServicePipelineDeploymentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
536
|
+
#
|
537
|
+
# * {Types::CancelServicePipelineDeploymentOutput#pipeline #pipeline} => Types::ServicePipeline
|
538
|
+
#
|
539
|
+
# @example Request syntax with placeholder values
|
540
|
+
#
|
541
|
+
# resp = client.cancel_service_pipeline_deployment({
|
542
|
+
# service_name: "ResourceName", # required
|
543
|
+
# })
|
544
|
+
#
|
545
|
+
# @example Response structure
|
546
|
+
#
|
547
|
+
# resp.pipeline.arn #=> String
|
548
|
+
# resp.pipeline.created_at #=> Time
|
549
|
+
# resp.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
550
|
+
# resp.pipeline.deployment_status_message #=> String
|
551
|
+
# resp.pipeline.last_deployment_attempted_at #=> Time
|
552
|
+
# resp.pipeline.last_deployment_succeeded_at #=> Time
|
553
|
+
# resp.pipeline.spec #=> String
|
554
|
+
# resp.pipeline.template_major_version #=> String
|
555
|
+
# resp.pipeline.template_minor_version #=> String
|
556
|
+
# resp.pipeline.template_name #=> String
|
557
|
+
#
|
558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CancelServicePipelineDeployment AWS API Documentation
|
559
|
+
#
|
560
|
+
# @overload cancel_service_pipeline_deployment(params = {})
|
561
|
+
# @param [Hash] params ({})
|
562
|
+
def cancel_service_pipeline_deployment(params = {}, options = {})
|
563
|
+
req = build_request(:cancel_service_pipeline_deployment, params)
|
564
|
+
req.send_request(options)
|
565
|
+
end
|
566
|
+
|
567
|
+
# Deploy a new environment. An AWS Proton environment is created from an
|
568
|
+
# environment template that defines infrastructure and resources that
|
569
|
+
# can be shared across services. For more information, see the
|
570
|
+
# [Environments][1] in the *AWS Proton Administration Guide.*
|
571
|
+
#
|
572
|
+
#
|
573
|
+
#
|
574
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html
|
575
|
+
#
|
576
|
+
# @option params [String] :description
|
577
|
+
# A description of the environment that's being created and deployed.
|
578
|
+
#
|
579
|
+
# @option params [String] :environment_account_connection_id
|
580
|
+
# The ID of the environment account connection that you provide if
|
581
|
+
# you're provisioning your environment infrastructure resources to an
|
582
|
+
# environment account. You must include either the
|
583
|
+
# `environmentAccountConnectionId` or `protonServiceRoleArn` parameter
|
584
|
+
# and value. For more information, see [Environment account
|
585
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
586
|
+
# in the *AWS Proton Administration guide*.
|
587
|
+
#
|
588
|
+
# @option params [required, String] :name
|
589
|
+
# The name of the environment.
|
590
|
+
#
|
591
|
+
# @option params [String] :proton_service_role_arn
|
592
|
+
# The Amazon Resource Name (ARN) of the AWS Proton service role that
|
593
|
+
# allows AWS Proton to make calls to other services on your behalf. You
|
594
|
+
# must include either the `environmentAccountConnectionId` or
|
595
|
+
# `protonServiceRoleArn` parameter and value.
|
596
|
+
#
|
597
|
+
# @option params [required, String] :spec
|
598
|
+
# A link to a YAML formatted spec file that provides inputs as defined
|
599
|
+
# in the environment template bundle schema file. For more information,
|
600
|
+
# see [Environments][1] in the *AWS Proton Administration Guide*.
|
601
|
+
#
|
602
|
+
#
|
603
|
+
#
|
604
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-managing-environments.html
|
605
|
+
#
|
606
|
+
# @option params [Array<Types::Tag>] :tags
|
607
|
+
# Create tags for your environment. For more information, see *AWS
|
608
|
+
# Proton resources and tagging* in the [AWS Proton Administration
|
609
|
+
# Guide][1] or [AWS Proton User Guide][2].
|
610
|
+
#
|
611
|
+
#
|
612
|
+
#
|
613
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
614
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
615
|
+
#
|
616
|
+
# @option params [required, String] :template_major_version
|
617
|
+
# The ID of the major version of the environment template.
|
618
|
+
#
|
619
|
+
# @option params [String] :template_minor_version
|
620
|
+
# The ID of the minor version of the environment template.
|
621
|
+
#
|
622
|
+
# @option params [required, String] :template_name
|
623
|
+
# The name of the environment template. For more information, see
|
624
|
+
# [Environment Templates][1] in the *AWS Proton Administration Guide*.
|
625
|
+
#
|
626
|
+
#
|
627
|
+
#
|
628
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html
|
629
|
+
#
|
630
|
+
# @return [Types::CreateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
631
|
+
#
|
632
|
+
# * {Types::CreateEnvironmentOutput#environment #environment} => Types::Environment
|
633
|
+
#
|
634
|
+
# @example Request syntax with placeholder values
|
635
|
+
#
|
636
|
+
# resp = client.create_environment({
|
637
|
+
# description: "Description",
|
638
|
+
# environment_account_connection_id: "EnvironmentAccountConnectionId",
|
639
|
+
# name: "ResourceName", # required
|
640
|
+
# proton_service_role_arn: "Arn",
|
641
|
+
# spec: "SpecContents", # required
|
642
|
+
# tags: [
|
643
|
+
# {
|
644
|
+
# key: "TagKey", # required
|
645
|
+
# value: "TagValue", # required
|
646
|
+
# },
|
647
|
+
# ],
|
648
|
+
# template_major_version: "TemplateVersionPart", # required
|
649
|
+
# template_minor_version: "TemplateVersionPart",
|
650
|
+
# template_name: "ResourceName", # required
|
651
|
+
# })
|
652
|
+
#
|
653
|
+
# @example Response structure
|
654
|
+
#
|
655
|
+
# resp.environment.arn #=> String
|
656
|
+
# resp.environment.created_at #=> Time
|
657
|
+
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
658
|
+
# resp.environment.deployment_status_message #=> String
|
659
|
+
# resp.environment.description #=> String
|
660
|
+
# resp.environment.environment_account_connection_id #=> String
|
661
|
+
# resp.environment.environment_account_id #=> String
|
662
|
+
# resp.environment.last_deployment_attempted_at #=> Time
|
663
|
+
# resp.environment.last_deployment_succeeded_at #=> Time
|
664
|
+
# resp.environment.name #=> String
|
665
|
+
# resp.environment.proton_service_role_arn #=> String
|
666
|
+
# resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
667
|
+
# resp.environment.spec #=> String
|
668
|
+
# resp.environment.template_major_version #=> String
|
669
|
+
# resp.environment.template_minor_version #=> String
|
670
|
+
# resp.environment.template_name #=> String
|
671
|
+
#
|
672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironment AWS API Documentation
|
673
|
+
#
|
674
|
+
# @overload create_environment(params = {})
|
675
|
+
# @param [Hash] params ({})
|
676
|
+
def create_environment(params = {}, options = {})
|
677
|
+
req = build_request(:create_environment, params)
|
678
|
+
req.send_request(options)
|
679
|
+
end
|
680
|
+
|
681
|
+
# Create an environment account connection in an environment account so
|
682
|
+
# that environment infrastructure resources can be provisioned in the
|
683
|
+
# environment account from the management account.
|
684
|
+
#
|
685
|
+
# An environment account connection is a secure bi-directional
|
686
|
+
# connection between a *management account* and an *environment account*
|
687
|
+
# that maintains authorization and permissions. For more information,
|
688
|
+
# see [Environment account
|
689
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
690
|
+
# in the *AWS Proton Administration guide*.
|
691
|
+
#
|
692
|
+
# @option params [String] :client_token
|
693
|
+
# When included, if two identicial requests are made with the same
|
694
|
+
# client token, AWS Proton returns the environment account connection
|
695
|
+
# that the first request created.
|
696
|
+
#
|
697
|
+
# **A suitable default value is auto-generated.** You should normally
|
698
|
+
# not need to pass this option.**
|
699
|
+
#
|
700
|
+
# @option params [required, String] :environment_name
|
701
|
+
# The name of the AWS Proton environment that's created in the
|
702
|
+
# associated management account.
|
703
|
+
#
|
704
|
+
# @option params [required, String] :management_account_id
|
705
|
+
# The ID of the management account that accepts or rejects the
|
706
|
+
# environment account connection. You create an manage the AWS Proton
|
707
|
+
# environment in this account. If the management account accepts the
|
708
|
+
# environment account connection, AWS Proton can use the associated IAM
|
709
|
+
# role to provision environment infrastructure resources in the
|
710
|
+
# associated environment account.
|
711
|
+
#
|
712
|
+
# @option params [required, String] :role_arn
|
713
|
+
# The Amazon Resource Name (ARN) of the IAM service role that's created
|
714
|
+
# in the environment account. AWS Proton uses this role to provision
|
715
|
+
# infrastructure resources in the associated environment account.
|
716
|
+
#
|
717
|
+
# @return [Types::CreateEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
718
|
+
#
|
719
|
+
# * {Types::CreateEnvironmentAccountConnectionOutput#environment_account_connection #environment_account_connection} => Types::EnvironmentAccountConnection
|
720
|
+
#
|
721
|
+
# @example Request syntax with placeholder values
|
722
|
+
#
|
723
|
+
# resp = client.create_environment_account_connection({
|
724
|
+
# client_token: "ClientToken",
|
725
|
+
# environment_name: "ResourceName", # required
|
726
|
+
# management_account_id: "AwsAccountId", # required
|
727
|
+
# role_arn: "Arn", # required
|
728
|
+
# })
|
729
|
+
#
|
730
|
+
# @example Response structure
|
731
|
+
#
|
732
|
+
# resp.environment_account_connection.arn #=> String
|
733
|
+
# resp.environment_account_connection.environment_account_id #=> String
|
734
|
+
# resp.environment_account_connection.environment_name #=> String
|
735
|
+
# resp.environment_account_connection.id #=> String
|
736
|
+
# resp.environment_account_connection.last_modified_at #=> Time
|
737
|
+
# resp.environment_account_connection.management_account_id #=> String
|
738
|
+
# resp.environment_account_connection.requested_at #=> Time
|
739
|
+
# resp.environment_account_connection.role_arn #=> String
|
740
|
+
# resp.environment_account_connection.status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
741
|
+
#
|
742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentAccountConnection AWS API Documentation
|
743
|
+
#
|
744
|
+
# @overload create_environment_account_connection(params = {})
|
745
|
+
# @param [Hash] params ({})
|
746
|
+
def create_environment_account_connection(params = {}, options = {})
|
747
|
+
req = build_request(:create_environment_account_connection, params)
|
748
|
+
req.send_request(options)
|
749
|
+
end
|
750
|
+
|
751
|
+
# Create an environment template for AWS Proton. For more information,
|
752
|
+
# see [Environment Templates][1] in the *AWS Proton Administration
|
753
|
+
# Guide*.
|
754
|
+
#
|
755
|
+
# You can create an environment template in one of the two following
|
756
|
+
# ways:
|
757
|
+
#
|
758
|
+
# * Register and publish a *standard* environment template that
|
759
|
+
# instructs AWS Proton to deploy and manage environment
|
760
|
+
# infrastructure.
|
761
|
+
#
|
762
|
+
# * Register and publish a *customer managed* environment template that
|
763
|
+
# connects AWS Proton to your existing provisioned infrastructure that
|
764
|
+
# you manage. AWS Proton *doesn't* manage your existing provisioned
|
765
|
+
# infrastructure. To create an environment template for customer
|
766
|
+
# provisioned and managed infrastructure, include the `provisioning`
|
767
|
+
# parameter and set the value to `CUSTOMER_MANAGED`. For more
|
768
|
+
# information, see [Register and publish an environment template][2]
|
769
|
+
# in the *AWS Proton Administration Guide*.
|
770
|
+
#
|
771
|
+
#
|
772
|
+
#
|
773
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-templates.html
|
774
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/adminguide/env-template-v1.html
|
775
|
+
#
|
776
|
+
# @option params [String] :description
|
777
|
+
# A description of the environment template.
|
778
|
+
#
|
779
|
+
# @option params [String] :display_name
|
780
|
+
# The environment template name as displayed in the developer interface.
|
781
|
+
#
|
782
|
+
# @option params [String] :encryption_key
|
783
|
+
# A customer provided encryption key that AWS Proton uses to encrypt
|
784
|
+
# data.
|
785
|
+
#
|
786
|
+
# @option params [required, String] :name
|
787
|
+
# The name of the environment template.
|
788
|
+
#
|
789
|
+
# @option params [String] :provisioning
|
790
|
+
# When included, indicates that the environment template is for customer
|
791
|
+
# provisioned and managed infrastructure.
|
792
|
+
#
|
793
|
+
# @option params [Array<Types::Tag>] :tags
|
794
|
+
# Create tags for your environment template. For more information, see
|
795
|
+
# *AWS Proton resources and tagging* in the [AWS Proton Administration
|
796
|
+
# Guide][1] or [AWS Proton User Guide][2].
|
797
|
+
#
|
798
|
+
#
|
799
|
+
#
|
800
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
801
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
802
|
+
#
|
803
|
+
# @return [Types::CreateEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
804
|
+
#
|
805
|
+
# * {Types::CreateEnvironmentTemplateOutput#environment_template #environment_template} => Types::EnvironmentTemplate
|
806
|
+
#
|
807
|
+
# @example Request syntax with placeholder values
|
808
|
+
#
|
809
|
+
# resp = client.create_environment_template({
|
810
|
+
# description: "Description",
|
811
|
+
# display_name: "DisplayName",
|
812
|
+
# encryption_key: "Arn",
|
813
|
+
# name: "ResourceName", # required
|
814
|
+
# provisioning: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED
|
815
|
+
# tags: [
|
816
|
+
# {
|
817
|
+
# key: "TagKey", # required
|
818
|
+
# value: "TagValue", # required
|
819
|
+
# },
|
820
|
+
# ],
|
821
|
+
# })
|
822
|
+
#
|
823
|
+
# @example Response structure
|
824
|
+
#
|
825
|
+
# resp.environment_template.arn #=> String
|
826
|
+
# resp.environment_template.created_at #=> Time
|
827
|
+
# resp.environment_template.description #=> String
|
828
|
+
# resp.environment_template.display_name #=> String
|
829
|
+
# resp.environment_template.encryption_key #=> String
|
830
|
+
# resp.environment_template.last_modified_at #=> Time
|
831
|
+
# resp.environment_template.name #=> String
|
832
|
+
# resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
833
|
+
# resp.environment_template.recommended_version #=> String
|
834
|
+
#
|
835
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplate AWS API Documentation
|
836
|
+
#
|
837
|
+
# @overload create_environment_template(params = {})
|
838
|
+
# @param [Hash] params ({})
|
839
|
+
def create_environment_template(params = {}, options = {})
|
840
|
+
req = build_request(:create_environment_template, params)
|
841
|
+
req.send_request(options)
|
842
|
+
end
|
843
|
+
|
844
|
+
# Create a new major or minor version of an environment template. A
|
845
|
+
# major version of an environment template is a version that *isn't*
|
846
|
+
# backwards compatible. A minor version of an environment template is a
|
847
|
+
# version that's backwards compatible within its major version.
|
848
|
+
#
|
849
|
+
# @option params [String] :client_token
|
850
|
+
# When included, if two identicial requests are made with the same
|
851
|
+
# client token, AWS Proton returns the environment template version that
|
852
|
+
# the first request created.
|
853
|
+
#
|
854
|
+
# **A suitable default value is auto-generated.** You should normally
|
855
|
+
# not need to pass this option.**
|
856
|
+
#
|
857
|
+
# @option params [String] :description
|
858
|
+
# A description of the new version of an environment template.
|
859
|
+
#
|
860
|
+
# @option params [String] :major_version
|
861
|
+
# To create a new minor version of the environment template, include a
|
862
|
+
# `majorVersion`.
|
863
|
+
#
|
864
|
+
# To create a new major and minor version of the environment template,
|
865
|
+
# exclude `majorVersion`.
|
866
|
+
#
|
867
|
+
# @option params [required, Types::TemplateVersionSourceInput] :source
|
868
|
+
# An object that includes the template bundle S3 bucket path and name
|
869
|
+
# for the new version of an template.
|
870
|
+
#
|
871
|
+
# @option params [Array<Types::Tag>] :tags
|
872
|
+
# Create tags for a new version of an environment template.
|
873
|
+
#
|
874
|
+
# @option params [required, String] :template_name
|
875
|
+
# The name of the environment template.
|
876
|
+
#
|
877
|
+
# @return [Types::CreateEnvironmentTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
878
|
+
#
|
879
|
+
# * {Types::CreateEnvironmentTemplateVersionOutput#environment_template_version #environment_template_version} => Types::EnvironmentTemplateVersion
|
880
|
+
#
|
881
|
+
# @example Request syntax with placeholder values
|
882
|
+
#
|
883
|
+
# resp = client.create_environment_template_version({
|
884
|
+
# client_token: "ClientToken",
|
885
|
+
# description: "Description",
|
886
|
+
# major_version: "TemplateVersionPart",
|
887
|
+
# source: { # required
|
888
|
+
# s3: {
|
889
|
+
# bucket: "S3Bucket", # required
|
890
|
+
# key: "S3Key", # required
|
891
|
+
# },
|
892
|
+
# },
|
893
|
+
# tags: [
|
894
|
+
# {
|
895
|
+
# key: "TagKey", # required
|
896
|
+
# value: "TagValue", # required
|
897
|
+
# },
|
898
|
+
# ],
|
899
|
+
# template_name: "ResourceName", # required
|
900
|
+
# })
|
901
|
+
#
|
902
|
+
# @example Response structure
|
903
|
+
#
|
904
|
+
# resp.environment_template_version.arn #=> String
|
905
|
+
# resp.environment_template_version.created_at #=> Time
|
906
|
+
# resp.environment_template_version.description #=> String
|
907
|
+
# resp.environment_template_version.last_modified_at #=> Time
|
908
|
+
# resp.environment_template_version.major_version #=> String
|
909
|
+
# resp.environment_template_version.minor_version #=> String
|
910
|
+
# resp.environment_template_version.recommended_minor_version #=> String
|
911
|
+
# resp.environment_template_version.schema #=> String
|
912
|
+
# resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
913
|
+
# resp.environment_template_version.status_message #=> String
|
914
|
+
# resp.environment_template_version.template_name #=> String
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateEnvironmentTemplateVersion AWS API Documentation
|
917
|
+
#
|
918
|
+
# @overload create_environment_template_version(params = {})
|
919
|
+
# @param [Hash] params ({})
|
920
|
+
def create_environment_template_version(params = {}, options = {})
|
921
|
+
req = build_request(:create_environment_template_version, params)
|
922
|
+
req.send_request(options)
|
923
|
+
end
|
924
|
+
|
925
|
+
# Create an AWS Proton service. An AWS Proton service is an
|
926
|
+
# instantiation of a service template and often includes several service
|
927
|
+
# instances and pipeline. For more information, see [Services][1] in the
|
928
|
+
# *AWS Proton Administration Guide* and [Services][2] in the *AWS Proton
|
929
|
+
# User Guide*.
|
930
|
+
#
|
931
|
+
#
|
932
|
+
#
|
933
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html
|
934
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html
|
935
|
+
#
|
936
|
+
# @option params [String] :branch_name
|
937
|
+
# The name of the code repository branch that holds the code that's
|
938
|
+
# deployed in AWS Proton. *Don't* include this parameter if your
|
939
|
+
# service template *doesn't* include a service pipeline.
|
940
|
+
#
|
941
|
+
# @option params [String] :description
|
942
|
+
# A description of the AWS Proton service.
|
943
|
+
#
|
944
|
+
# @option params [required, String] :name
|
945
|
+
# The service name.
|
946
|
+
#
|
947
|
+
# @option params [String] :repository_connection_arn
|
948
|
+
# The ARN of the repository connection. For more information, see [Set
|
949
|
+
# up repository connection][1] in the *AWS Proton Administration Guide*
|
950
|
+
# and [Getting started][2] in the *AWS Proton User Guide*. *Don't*
|
951
|
+
# include this parameter if your service template *doesn't* include a
|
952
|
+
# service pipeline.
|
953
|
+
#
|
954
|
+
#
|
955
|
+
#
|
956
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/setting-up-for-service.html#settingSS-up-vcontrol
|
957
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-getting-started.html#getting-started-step1
|
958
|
+
#
|
959
|
+
# @option params [String] :repository_id
|
960
|
+
# The ID of the code repository. *Don't* include this parameter if your
|
961
|
+
# service template *doesn't* include a service pipeline.
|
962
|
+
#
|
963
|
+
# @option params [required, String] :spec
|
964
|
+
# A link to a spec file that provides inputs as defined in the service
|
965
|
+
# template bundle schema file. The spec file is in YAML format. Don’t
|
966
|
+
# include pipeline inputs in the spec if your service template doesn’t
|
967
|
+
# include a service pipeline. For more information, see [Create a
|
968
|
+
# service][1] in the *AWS Proton Administration Guide* and [Create a
|
969
|
+
# service][2] in the *AWS Proton User Guide*.
|
970
|
+
#
|
971
|
+
#
|
972
|
+
#
|
973
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html.html
|
974
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html
|
975
|
+
#
|
976
|
+
# @option params [Array<Types::Tag>] :tags
|
977
|
+
# Create tags for your service. For more information, see *AWS Proton
|
978
|
+
# resources and tagging* in the [AWS Proton Administration Guide][1] or
|
979
|
+
# [AWS Proton User Guide][2].
|
980
|
+
#
|
981
|
+
#
|
982
|
+
#
|
983
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
984
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
985
|
+
#
|
986
|
+
# @option params [required, String] :template_major_version
|
987
|
+
# The ID of the major version of the service template that was used to
|
988
|
+
# create the service.
|
989
|
+
#
|
990
|
+
# @option params [String] :template_minor_version
|
991
|
+
# The ID of the minor version of the service template that was used to
|
992
|
+
# create the service.
|
993
|
+
#
|
994
|
+
# @option params [required, String] :template_name
|
995
|
+
# The name of the service template that's used to create the service.
|
996
|
+
#
|
997
|
+
# @return [Types::CreateServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
998
|
+
#
|
999
|
+
# * {Types::CreateServiceOutput#service #service} => Types::Service
|
1000
|
+
#
|
1001
|
+
# @example Request syntax with placeholder values
|
1002
|
+
#
|
1003
|
+
# resp = client.create_service({
|
1004
|
+
# branch_name: "GitBranchName",
|
1005
|
+
# description: "Description",
|
1006
|
+
# name: "ResourceName", # required
|
1007
|
+
# repository_connection_arn: "Arn",
|
1008
|
+
# repository_id: "RepositoryId",
|
1009
|
+
# spec: "SpecContents", # required
|
1010
|
+
# tags: [
|
1011
|
+
# {
|
1012
|
+
# key: "TagKey", # required
|
1013
|
+
# value: "TagValue", # required
|
1014
|
+
# },
|
1015
|
+
# ],
|
1016
|
+
# template_major_version: "TemplateVersionPart", # required
|
1017
|
+
# template_minor_version: "TemplateVersionPart",
|
1018
|
+
# template_name: "ResourceName", # required
|
1019
|
+
# })
|
1020
|
+
#
|
1021
|
+
# @example Response structure
|
1022
|
+
#
|
1023
|
+
# resp.service.arn #=> String
|
1024
|
+
# resp.service.branch_name #=> String
|
1025
|
+
# resp.service.created_at #=> Time
|
1026
|
+
# resp.service.description #=> String
|
1027
|
+
# resp.service.last_modified_at #=> Time
|
1028
|
+
# resp.service.name #=> String
|
1029
|
+
# resp.service.pipeline.arn #=> String
|
1030
|
+
# resp.service.pipeline.created_at #=> Time
|
1031
|
+
# resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1032
|
+
# resp.service.pipeline.deployment_status_message #=> String
|
1033
|
+
# resp.service.pipeline.last_deployment_attempted_at #=> Time
|
1034
|
+
# resp.service.pipeline.last_deployment_succeeded_at #=> Time
|
1035
|
+
# resp.service.pipeline.spec #=> String
|
1036
|
+
# resp.service.pipeline.template_major_version #=> String
|
1037
|
+
# resp.service.pipeline.template_minor_version #=> String
|
1038
|
+
# resp.service.pipeline.template_name #=> String
|
1039
|
+
# resp.service.repository_connection_arn #=> String
|
1040
|
+
# resp.service.repository_id #=> String
|
1041
|
+
# resp.service.spec #=> String
|
1042
|
+
# resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
|
1043
|
+
# resp.service.status_message #=> String
|
1044
|
+
# resp.service.template_name #=> String
|
1045
|
+
#
|
1046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateService AWS API Documentation
|
1047
|
+
#
|
1048
|
+
# @overload create_service(params = {})
|
1049
|
+
# @param [Hash] params ({})
|
1050
|
+
def create_service(params = {}, options = {})
|
1051
|
+
req = build_request(:create_service, params)
|
1052
|
+
req.send_request(options)
|
1053
|
+
end
|
1054
|
+
|
1055
|
+
# Create a service template. The administrator creates a service
|
1056
|
+
# template to define standardized infrastructure and an optional CICD
|
1057
|
+
# service pipeline. Developers, in turn, select the service template
|
1058
|
+
# from AWS Proton. If the selected service template includes a service
|
1059
|
+
# pipeline definition, they provide a link to their source code
|
1060
|
+
# repository. AWS Proton then deploys and manages the infrastructure
|
1061
|
+
# defined by the selected service template. For more information, see
|
1062
|
+
# [Service Templates][1] in the *AWS Proton Administration Guide*.
|
1063
|
+
#
|
1064
|
+
#
|
1065
|
+
#
|
1066
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html
|
1067
|
+
#
|
1068
|
+
# @option params [String] :description
|
1069
|
+
# A description of the service template.
|
1070
|
+
#
|
1071
|
+
# @option params [String] :display_name
|
1072
|
+
# The name of the service template as displayed in the developer
|
1073
|
+
# interface.
|
1074
|
+
#
|
1075
|
+
# @option params [String] :encryption_key
|
1076
|
+
# A customer provided encryption key that's used to encrypt data.
|
1077
|
+
#
|
1078
|
+
# @option params [required, String] :name
|
1079
|
+
# The name of the service template.
|
1080
|
+
#
|
1081
|
+
# @option params [String] :pipeline_provisioning
|
1082
|
+
# AWS Proton includes a service pipeline for your service by default.
|
1083
|
+
# When included, this parameter indicates that an AWS Proton service
|
1084
|
+
# pipeline *won't* be included for your service. Once specified, this
|
1085
|
+
# parameter *can't* be changed. For more information, see [Service
|
1086
|
+
# template bundles][1] in the *AWS Proton Administration Guide*.
|
1087
|
+
#
|
1088
|
+
#
|
1089
|
+
#
|
1090
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-template-bundles.html
|
1091
|
+
#
|
1092
|
+
# @option params [Array<Types::Tag>] :tags
|
1093
|
+
# Create tags for your service template. For more information, see *AWS
|
1094
|
+
# Proton resources and tagging* in the [AWS Proton Administration
|
1095
|
+
# Guide][1] or [AWS Proton User Guide][2].
|
1096
|
+
#
|
1097
|
+
#
|
1098
|
+
#
|
1099
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
1100
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
1101
|
+
#
|
1102
|
+
# @return [Types::CreateServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1103
|
+
#
|
1104
|
+
# * {Types::CreateServiceTemplateOutput#service_template #service_template} => Types::ServiceTemplate
|
1105
|
+
#
|
1106
|
+
# @example Request syntax with placeholder values
|
1107
|
+
#
|
1108
|
+
# resp = client.create_service_template({
|
1109
|
+
# description: "Description",
|
1110
|
+
# display_name: "DisplayName",
|
1111
|
+
# encryption_key: "Arn",
|
1112
|
+
# name: "ResourceName", # required
|
1113
|
+
# pipeline_provisioning: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED
|
1114
|
+
# tags: [
|
1115
|
+
# {
|
1116
|
+
# key: "TagKey", # required
|
1117
|
+
# value: "TagValue", # required
|
1118
|
+
# },
|
1119
|
+
# ],
|
1120
|
+
# })
|
1121
|
+
#
|
1122
|
+
# @example Response structure
|
1123
|
+
#
|
1124
|
+
# resp.service_template.arn #=> String
|
1125
|
+
# resp.service_template.created_at #=> Time
|
1126
|
+
# resp.service_template.description #=> String
|
1127
|
+
# resp.service_template.display_name #=> String
|
1128
|
+
# resp.service_template.encryption_key #=> String
|
1129
|
+
# resp.service_template.last_modified_at #=> Time
|
1130
|
+
# resp.service_template.name #=> String
|
1131
|
+
# resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1132
|
+
# resp.service_template.recommended_version #=> String
|
1133
|
+
#
|
1134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplate AWS API Documentation
|
1135
|
+
#
|
1136
|
+
# @overload create_service_template(params = {})
|
1137
|
+
# @param [Hash] params ({})
|
1138
|
+
def create_service_template(params = {}, options = {})
|
1139
|
+
req = build_request(:create_service_template, params)
|
1140
|
+
req.send_request(options)
|
1141
|
+
end
|
1142
|
+
|
1143
|
+
# Create a new major or minor version of a service template. A major
|
1144
|
+
# version of a service template is a version that *isn't* backwards
|
1145
|
+
# compatible. A minor version of a service template is a version that's
|
1146
|
+
# backwards compatible within its major version.
|
1147
|
+
#
|
1148
|
+
# @option params [String] :client_token
|
1149
|
+
# When included, if two identicial requests are made with the same
|
1150
|
+
# client token, AWS Proton returns the service template version that the
|
1151
|
+
# first request created.
|
1152
|
+
#
|
1153
|
+
# **A suitable default value is auto-generated.** You should normally
|
1154
|
+
# not need to pass this option.**
|
1155
|
+
#
|
1156
|
+
# @option params [required, Array<Types::CompatibleEnvironmentTemplateInput>] :compatible_environment_templates
|
1157
|
+
# An array of compatible environment template objects for the new
|
1158
|
+
# version of a service template.
|
1159
|
+
#
|
1160
|
+
# @option params [String] :description
|
1161
|
+
# A description of the new version of a service template.
|
1162
|
+
#
|
1163
|
+
# @option params [String] :major_version
|
1164
|
+
# To create a new minor version of the service template, include a
|
1165
|
+
# `majorVersion`.
|
1166
|
+
#
|
1167
|
+
# To create a new major and minor version of the service template,
|
1168
|
+
# *exclude* `majorVersion`.
|
1169
|
+
#
|
1170
|
+
# @option params [required, Types::TemplateVersionSourceInput] :source
|
1171
|
+
# An object that includes the template bundle S3 bucket path and name
|
1172
|
+
# for the new version of a service template.
|
1173
|
+
#
|
1174
|
+
# @option params [Array<Types::Tag>] :tags
|
1175
|
+
# Create tags for a new version of a service template.
|
1176
|
+
#
|
1177
|
+
# @option params [required, String] :template_name
|
1178
|
+
# The name of the service template.
|
1179
|
+
#
|
1180
|
+
# @return [Types::CreateServiceTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1181
|
+
#
|
1182
|
+
# * {Types::CreateServiceTemplateVersionOutput#service_template_version #service_template_version} => Types::ServiceTemplateVersion
|
1183
|
+
#
|
1184
|
+
# @example Request syntax with placeholder values
|
1185
|
+
#
|
1186
|
+
# resp = client.create_service_template_version({
|
1187
|
+
# client_token: "ClientToken",
|
1188
|
+
# compatible_environment_templates: [ # required
|
1189
|
+
# {
|
1190
|
+
# major_version: "TemplateVersionPart", # required
|
1191
|
+
# template_name: "ResourceName", # required
|
1192
|
+
# },
|
1193
|
+
# ],
|
1194
|
+
# description: "Description",
|
1195
|
+
# major_version: "TemplateVersionPart",
|
1196
|
+
# source: { # required
|
1197
|
+
# s3: {
|
1198
|
+
# bucket: "S3Bucket", # required
|
1199
|
+
# key: "S3Key", # required
|
1200
|
+
# },
|
1201
|
+
# },
|
1202
|
+
# tags: [
|
1203
|
+
# {
|
1204
|
+
# key: "TagKey", # required
|
1205
|
+
# value: "TagValue", # required
|
1206
|
+
# },
|
1207
|
+
# ],
|
1208
|
+
# template_name: "ResourceName", # required
|
1209
|
+
# })
|
1210
|
+
#
|
1211
|
+
# @example Response structure
|
1212
|
+
#
|
1213
|
+
# resp.service_template_version.arn #=> String
|
1214
|
+
# resp.service_template_version.compatible_environment_templates #=> Array
|
1215
|
+
# resp.service_template_version.compatible_environment_templates[0].major_version #=> String
|
1216
|
+
# resp.service_template_version.compatible_environment_templates[0].template_name #=> String
|
1217
|
+
# resp.service_template_version.created_at #=> Time
|
1218
|
+
# resp.service_template_version.description #=> String
|
1219
|
+
# resp.service_template_version.last_modified_at #=> Time
|
1220
|
+
# resp.service_template_version.major_version #=> String
|
1221
|
+
# resp.service_template_version.minor_version #=> String
|
1222
|
+
# resp.service_template_version.recommended_minor_version #=> String
|
1223
|
+
# resp.service_template_version.schema #=> String
|
1224
|
+
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1225
|
+
# resp.service_template_version.status_message #=> String
|
1226
|
+
# resp.service_template_version.template_name #=> String
|
1227
|
+
#
|
1228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/CreateServiceTemplateVersion AWS API Documentation
|
1229
|
+
#
|
1230
|
+
# @overload create_service_template_version(params = {})
|
1231
|
+
# @param [Hash] params ({})
|
1232
|
+
def create_service_template_version(params = {}, options = {})
|
1233
|
+
req = build_request(:create_service_template_version, params)
|
1234
|
+
req.send_request(options)
|
1235
|
+
end
|
1236
|
+
|
1237
|
+
# Delete an environment.
|
1238
|
+
#
|
1239
|
+
# @option params [required, String] :name
|
1240
|
+
# The name of the environment to delete.
|
1241
|
+
#
|
1242
|
+
# @return [Types::DeleteEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1243
|
+
#
|
1244
|
+
# * {Types::DeleteEnvironmentOutput#environment #environment} => Types::Environment
|
1245
|
+
#
|
1246
|
+
# @example Request syntax with placeholder values
|
1247
|
+
#
|
1248
|
+
# resp = client.delete_environment({
|
1249
|
+
# name: "ResourceName", # required
|
1250
|
+
# })
|
1251
|
+
#
|
1252
|
+
# @example Response structure
|
1253
|
+
#
|
1254
|
+
# resp.environment.arn #=> String
|
1255
|
+
# resp.environment.created_at #=> Time
|
1256
|
+
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1257
|
+
# resp.environment.deployment_status_message #=> String
|
1258
|
+
# resp.environment.description #=> String
|
1259
|
+
# resp.environment.environment_account_connection_id #=> String
|
1260
|
+
# resp.environment.environment_account_id #=> String
|
1261
|
+
# resp.environment.last_deployment_attempted_at #=> Time
|
1262
|
+
# resp.environment.last_deployment_succeeded_at #=> Time
|
1263
|
+
# resp.environment.name #=> String
|
1264
|
+
# resp.environment.proton_service_role_arn #=> String
|
1265
|
+
# resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1266
|
+
# resp.environment.spec #=> String
|
1267
|
+
# resp.environment.template_major_version #=> String
|
1268
|
+
# resp.environment.template_minor_version #=> String
|
1269
|
+
# resp.environment.template_name #=> String
|
1270
|
+
#
|
1271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironment AWS API Documentation
|
1272
|
+
#
|
1273
|
+
# @overload delete_environment(params = {})
|
1274
|
+
# @param [Hash] params ({})
|
1275
|
+
def delete_environment(params = {}, options = {})
|
1276
|
+
req = build_request(:delete_environment, params)
|
1277
|
+
req.send_request(options)
|
1278
|
+
end
|
1279
|
+
|
1280
|
+
# In an environment account, delete an environment account connection.
|
1281
|
+
#
|
1282
|
+
# After you delete an environment account connection that’s in use by an
|
1283
|
+
# AWS Proton environment, AWS Proton *can’t* manage the environment
|
1284
|
+
# infrastructure resources until a new environment account connection is
|
1285
|
+
# accepted for the environment account and associated environment.
|
1286
|
+
# You're responsible for cleaning up provisioned resources that remain
|
1287
|
+
# without an environment connection.
|
1288
|
+
#
|
1289
|
+
# For more information, see [Environment account
|
1290
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
1291
|
+
# in the *AWS Proton Administration guide*.
|
1292
|
+
#
|
1293
|
+
# @option params [required, String] :id
|
1294
|
+
# The ID of the environment account connection to delete.
|
1295
|
+
#
|
1296
|
+
# @return [Types::DeleteEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1297
|
+
#
|
1298
|
+
# * {Types::DeleteEnvironmentAccountConnectionOutput#environment_account_connection #environment_account_connection} => Types::EnvironmentAccountConnection
|
1299
|
+
#
|
1300
|
+
# @example Request syntax with placeholder values
|
1301
|
+
#
|
1302
|
+
# resp = client.delete_environment_account_connection({
|
1303
|
+
# id: "EnvironmentAccountConnectionId", # required
|
1304
|
+
# })
|
1305
|
+
#
|
1306
|
+
# @example Response structure
|
1307
|
+
#
|
1308
|
+
# resp.environment_account_connection.arn #=> String
|
1309
|
+
# resp.environment_account_connection.environment_account_id #=> String
|
1310
|
+
# resp.environment_account_connection.environment_name #=> String
|
1311
|
+
# resp.environment_account_connection.id #=> String
|
1312
|
+
# resp.environment_account_connection.last_modified_at #=> Time
|
1313
|
+
# resp.environment_account_connection.management_account_id #=> String
|
1314
|
+
# resp.environment_account_connection.requested_at #=> Time
|
1315
|
+
# resp.environment_account_connection.role_arn #=> String
|
1316
|
+
# resp.environment_account_connection.status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
1317
|
+
#
|
1318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentAccountConnection AWS API Documentation
|
1319
|
+
#
|
1320
|
+
# @overload delete_environment_account_connection(params = {})
|
1321
|
+
# @param [Hash] params ({})
|
1322
|
+
def delete_environment_account_connection(params = {}, options = {})
|
1323
|
+
req = build_request(:delete_environment_account_connection, params)
|
1324
|
+
req.send_request(options)
|
1325
|
+
end
|
1326
|
+
|
1327
|
+
# If no other major or minor versions of an environment template exist,
|
1328
|
+
# delete the environment template.
|
1329
|
+
#
|
1330
|
+
# @option params [required, String] :name
|
1331
|
+
# The name of the environment template to delete.
|
1332
|
+
#
|
1333
|
+
# @return [Types::DeleteEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1334
|
+
#
|
1335
|
+
# * {Types::DeleteEnvironmentTemplateOutput#environment_template #environment_template} => Types::EnvironmentTemplate
|
1336
|
+
#
|
1337
|
+
# @example Request syntax with placeholder values
|
1338
|
+
#
|
1339
|
+
# resp = client.delete_environment_template({
|
1340
|
+
# name: "ResourceName", # required
|
1341
|
+
# })
|
1342
|
+
#
|
1343
|
+
# @example Response structure
|
1344
|
+
#
|
1345
|
+
# resp.environment_template.arn #=> String
|
1346
|
+
# resp.environment_template.created_at #=> Time
|
1347
|
+
# resp.environment_template.description #=> String
|
1348
|
+
# resp.environment_template.display_name #=> String
|
1349
|
+
# resp.environment_template.encryption_key #=> String
|
1350
|
+
# resp.environment_template.last_modified_at #=> Time
|
1351
|
+
# resp.environment_template.name #=> String
|
1352
|
+
# resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1353
|
+
# resp.environment_template.recommended_version #=> String
|
1354
|
+
#
|
1355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplate AWS API Documentation
|
1356
|
+
#
|
1357
|
+
# @overload delete_environment_template(params = {})
|
1358
|
+
# @param [Hash] params ({})
|
1359
|
+
def delete_environment_template(params = {}, options = {})
|
1360
|
+
req = build_request(:delete_environment_template, params)
|
1361
|
+
req.send_request(options)
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
# If no other minor versions of an environment template exist, delete a
|
1365
|
+
# major version of the environment template if it's not the
|
1366
|
+
# `Recommended` version. Delete the `Recommended` version of the
|
1367
|
+
# environment template if no other major versions or minor versions of
|
1368
|
+
# the environment template exist. A major version of an environment
|
1369
|
+
# template is a version that's not backwards compatible.
|
1370
|
+
#
|
1371
|
+
# Delete a minor version of an environment template if it *isn't* the
|
1372
|
+
# `Recommended` version. Delete a `Recommended` minor version of the
|
1373
|
+
# environment template if no other minor versions of the environment
|
1374
|
+
# template exist. A minor version of an environment template is a
|
1375
|
+
# version that's backwards compatible.
|
1376
|
+
#
|
1377
|
+
# @option params [required, String] :major_version
|
1378
|
+
# The environment template major version to delete.
|
1379
|
+
#
|
1380
|
+
# @option params [required, String] :minor_version
|
1381
|
+
# The environment template minor version to delete.
|
1382
|
+
#
|
1383
|
+
# @option params [required, String] :template_name
|
1384
|
+
# The name of the environment template.
|
1385
|
+
#
|
1386
|
+
# @return [Types::DeleteEnvironmentTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1387
|
+
#
|
1388
|
+
# * {Types::DeleteEnvironmentTemplateVersionOutput#environment_template_version #environment_template_version} => Types::EnvironmentTemplateVersion
|
1389
|
+
#
|
1390
|
+
# @example Request syntax with placeholder values
|
1391
|
+
#
|
1392
|
+
# resp = client.delete_environment_template_version({
|
1393
|
+
# major_version: "TemplateVersionPart", # required
|
1394
|
+
# minor_version: "TemplateVersionPart", # required
|
1395
|
+
# template_name: "ResourceName", # required
|
1396
|
+
# })
|
1397
|
+
#
|
1398
|
+
# @example Response structure
|
1399
|
+
#
|
1400
|
+
# resp.environment_template_version.arn #=> String
|
1401
|
+
# resp.environment_template_version.created_at #=> Time
|
1402
|
+
# resp.environment_template_version.description #=> String
|
1403
|
+
# resp.environment_template_version.last_modified_at #=> Time
|
1404
|
+
# resp.environment_template_version.major_version #=> String
|
1405
|
+
# resp.environment_template_version.minor_version #=> String
|
1406
|
+
# resp.environment_template_version.recommended_minor_version #=> String
|
1407
|
+
# resp.environment_template_version.schema #=> String
|
1408
|
+
# resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1409
|
+
# resp.environment_template_version.status_message #=> String
|
1410
|
+
# resp.environment_template_version.template_name #=> String
|
1411
|
+
#
|
1412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteEnvironmentTemplateVersion AWS API Documentation
|
1413
|
+
#
|
1414
|
+
# @overload delete_environment_template_version(params = {})
|
1415
|
+
# @param [Hash] params ({})
|
1416
|
+
def delete_environment_template_version(params = {}, options = {})
|
1417
|
+
req = build_request(:delete_environment_template_version, params)
|
1418
|
+
req.send_request(options)
|
1419
|
+
end
|
1420
|
+
|
1421
|
+
# Delete a service.
|
1422
|
+
#
|
1423
|
+
# @option params [required, String] :name
|
1424
|
+
# The name of the service to delete.
|
1425
|
+
#
|
1426
|
+
# @return [Types::DeleteServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1427
|
+
#
|
1428
|
+
# * {Types::DeleteServiceOutput#service #service} => Types::Service
|
1429
|
+
#
|
1430
|
+
# @example Request syntax with placeholder values
|
1431
|
+
#
|
1432
|
+
# resp = client.delete_service({
|
1433
|
+
# name: "ResourceName", # required
|
1434
|
+
# })
|
1435
|
+
#
|
1436
|
+
# @example Response structure
|
1437
|
+
#
|
1438
|
+
# resp.service.arn #=> String
|
1439
|
+
# resp.service.branch_name #=> String
|
1440
|
+
# resp.service.created_at #=> Time
|
1441
|
+
# resp.service.description #=> String
|
1442
|
+
# resp.service.last_modified_at #=> Time
|
1443
|
+
# resp.service.name #=> String
|
1444
|
+
# resp.service.pipeline.arn #=> String
|
1445
|
+
# resp.service.pipeline.created_at #=> Time
|
1446
|
+
# resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1447
|
+
# resp.service.pipeline.deployment_status_message #=> String
|
1448
|
+
# resp.service.pipeline.last_deployment_attempted_at #=> Time
|
1449
|
+
# resp.service.pipeline.last_deployment_succeeded_at #=> Time
|
1450
|
+
# resp.service.pipeline.spec #=> String
|
1451
|
+
# resp.service.pipeline.template_major_version #=> String
|
1452
|
+
# resp.service.pipeline.template_minor_version #=> String
|
1453
|
+
# resp.service.pipeline.template_name #=> String
|
1454
|
+
# resp.service.repository_connection_arn #=> String
|
1455
|
+
# resp.service.repository_id #=> String
|
1456
|
+
# resp.service.spec #=> String
|
1457
|
+
# resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
|
1458
|
+
# resp.service.status_message #=> String
|
1459
|
+
# resp.service.template_name #=> String
|
1460
|
+
#
|
1461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteService AWS API Documentation
|
1462
|
+
#
|
1463
|
+
# @overload delete_service(params = {})
|
1464
|
+
# @param [Hash] params ({})
|
1465
|
+
def delete_service(params = {}, options = {})
|
1466
|
+
req = build_request(:delete_service, params)
|
1467
|
+
req.send_request(options)
|
1468
|
+
end
|
1469
|
+
|
1470
|
+
# If no other major or minor versions of the service template exist,
|
1471
|
+
# delete the service template.
|
1472
|
+
#
|
1473
|
+
# @option params [required, String] :name
|
1474
|
+
# The name of the service template to delete.
|
1475
|
+
#
|
1476
|
+
# @return [Types::DeleteServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1477
|
+
#
|
1478
|
+
# * {Types::DeleteServiceTemplateOutput#service_template #service_template} => Types::ServiceTemplate
|
1479
|
+
#
|
1480
|
+
# @example Request syntax with placeholder values
|
1481
|
+
#
|
1482
|
+
# resp = client.delete_service_template({
|
1483
|
+
# name: "ResourceName", # required
|
1484
|
+
# })
|
1485
|
+
#
|
1486
|
+
# @example Response structure
|
1487
|
+
#
|
1488
|
+
# resp.service_template.arn #=> String
|
1489
|
+
# resp.service_template.created_at #=> Time
|
1490
|
+
# resp.service_template.description #=> String
|
1491
|
+
# resp.service_template.display_name #=> String
|
1492
|
+
# resp.service_template.encryption_key #=> String
|
1493
|
+
# resp.service_template.last_modified_at #=> Time
|
1494
|
+
# resp.service_template.name #=> String
|
1495
|
+
# resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1496
|
+
# resp.service_template.recommended_version #=> String
|
1497
|
+
#
|
1498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplate AWS API Documentation
|
1499
|
+
#
|
1500
|
+
# @overload delete_service_template(params = {})
|
1501
|
+
# @param [Hash] params ({})
|
1502
|
+
def delete_service_template(params = {}, options = {})
|
1503
|
+
req = build_request(:delete_service_template, params)
|
1504
|
+
req.send_request(options)
|
1505
|
+
end
|
1506
|
+
|
1507
|
+
# If no other minor versions of a service template exist, delete a major
|
1508
|
+
# version of the service template if it's not the `Recommended`
|
1509
|
+
# version. Delete the `Recommended` version of the service template if
|
1510
|
+
# no other major versions or minor versions of the service template
|
1511
|
+
# exist. A major version of a service template is a version that
|
1512
|
+
# *isn't* backwards compatible.
|
1513
|
+
#
|
1514
|
+
# Delete a minor version of a service template if it's not the
|
1515
|
+
# `Recommended` version. Delete a `Recommended` minor version of the
|
1516
|
+
# service template if no other minor versions of the service template
|
1517
|
+
# exist. A minor version of a service template is a version that's
|
1518
|
+
# backwards compatible.
|
1519
|
+
#
|
1520
|
+
# @option params [required, String] :major_version
|
1521
|
+
# The service template major version to delete.
|
1522
|
+
#
|
1523
|
+
# @option params [required, String] :minor_version
|
1524
|
+
# The service template minor version to delete.
|
1525
|
+
#
|
1526
|
+
# @option params [required, String] :template_name
|
1527
|
+
# The name of the service template.
|
1528
|
+
#
|
1529
|
+
# @return [Types::DeleteServiceTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1530
|
+
#
|
1531
|
+
# * {Types::DeleteServiceTemplateVersionOutput#service_template_version #service_template_version} => Types::ServiceTemplateVersion
|
1532
|
+
#
|
1533
|
+
# @example Request syntax with placeholder values
|
1534
|
+
#
|
1535
|
+
# resp = client.delete_service_template_version({
|
1536
|
+
# major_version: "TemplateVersionPart", # required
|
1537
|
+
# minor_version: "TemplateVersionPart", # required
|
1538
|
+
# template_name: "ResourceName", # required
|
1539
|
+
# })
|
1540
|
+
#
|
1541
|
+
# @example Response structure
|
1542
|
+
#
|
1543
|
+
# resp.service_template_version.arn #=> String
|
1544
|
+
# resp.service_template_version.compatible_environment_templates #=> Array
|
1545
|
+
# resp.service_template_version.compatible_environment_templates[0].major_version #=> String
|
1546
|
+
# resp.service_template_version.compatible_environment_templates[0].template_name #=> String
|
1547
|
+
# resp.service_template_version.created_at #=> Time
|
1548
|
+
# resp.service_template_version.description #=> String
|
1549
|
+
# resp.service_template_version.last_modified_at #=> Time
|
1550
|
+
# resp.service_template_version.major_version #=> String
|
1551
|
+
# resp.service_template_version.minor_version #=> String
|
1552
|
+
# resp.service_template_version.recommended_minor_version #=> String
|
1553
|
+
# resp.service_template_version.schema #=> String
|
1554
|
+
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1555
|
+
# resp.service_template_version.status_message #=> String
|
1556
|
+
# resp.service_template_version.template_name #=> String
|
1557
|
+
#
|
1558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteServiceTemplateVersion AWS API Documentation
|
1559
|
+
#
|
1560
|
+
# @overload delete_service_template_version(params = {})
|
1561
|
+
# @param [Hash] params ({})
|
1562
|
+
def delete_service_template_version(params = {}, options = {})
|
1563
|
+
req = build_request(:delete_service_template_version, params)
|
1564
|
+
req.send_request(options)
|
1565
|
+
end
|
1566
|
+
|
1567
|
+
# Get detail data for the AWS Proton pipeline service role.
|
1568
|
+
#
|
1569
|
+
# @return [Types::GetAccountSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1570
|
+
#
|
1571
|
+
# * {Types::GetAccountSettingsOutput#account_settings #account_settings} => Types::AccountSettings
|
1572
|
+
#
|
1573
|
+
# @example Response structure
|
1574
|
+
#
|
1575
|
+
# resp.account_settings.pipeline_service_role_arn #=> String
|
1576
|
+
#
|
1577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetAccountSettings AWS API Documentation
|
1578
|
+
#
|
1579
|
+
# @overload get_account_settings(params = {})
|
1580
|
+
# @param [Hash] params ({})
|
1581
|
+
def get_account_settings(params = {}, options = {})
|
1582
|
+
req = build_request(:get_account_settings, params)
|
1583
|
+
req.send_request(options)
|
1584
|
+
end
|
1585
|
+
|
1586
|
+
# Get detail data for an environment.
|
1587
|
+
#
|
1588
|
+
# @option params [required, String] :name
|
1589
|
+
# The name of the environment that you want to get the detail data for.
|
1590
|
+
#
|
1591
|
+
# @return [Types::GetEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1592
|
+
#
|
1593
|
+
# * {Types::GetEnvironmentOutput#environment #environment} => Types::Environment
|
1594
|
+
#
|
1595
|
+
# @example Request syntax with placeholder values
|
1596
|
+
#
|
1597
|
+
# resp = client.get_environment({
|
1598
|
+
# name: "ResourceName", # required
|
1599
|
+
# })
|
1600
|
+
#
|
1601
|
+
# @example Response structure
|
1602
|
+
#
|
1603
|
+
# resp.environment.arn #=> String
|
1604
|
+
# resp.environment.created_at #=> Time
|
1605
|
+
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1606
|
+
# resp.environment.deployment_status_message #=> String
|
1607
|
+
# resp.environment.description #=> String
|
1608
|
+
# resp.environment.environment_account_connection_id #=> String
|
1609
|
+
# resp.environment.environment_account_id #=> String
|
1610
|
+
# resp.environment.last_deployment_attempted_at #=> Time
|
1611
|
+
# resp.environment.last_deployment_succeeded_at #=> Time
|
1612
|
+
# resp.environment.name #=> String
|
1613
|
+
# resp.environment.proton_service_role_arn #=> String
|
1614
|
+
# resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1615
|
+
# resp.environment.spec #=> String
|
1616
|
+
# resp.environment.template_major_version #=> String
|
1617
|
+
# resp.environment.template_minor_version #=> String
|
1618
|
+
# resp.environment.template_name #=> String
|
1619
|
+
#
|
1620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironment AWS API Documentation
|
1621
|
+
#
|
1622
|
+
# @overload get_environment(params = {})
|
1623
|
+
# @param [Hash] params ({})
|
1624
|
+
def get_environment(params = {}, options = {})
|
1625
|
+
req = build_request(:get_environment, params)
|
1626
|
+
req.send_request(options)
|
1627
|
+
end
|
1628
|
+
|
1629
|
+
# In an environment account, view the detail data for an environment
|
1630
|
+
# account connection.
|
1631
|
+
#
|
1632
|
+
# For more information, see [Environment account
|
1633
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
1634
|
+
# in the *AWS Proton Administration guide*.
|
1635
|
+
#
|
1636
|
+
# @option params [required, String] :id
|
1637
|
+
# The ID of the environment account connection.
|
1638
|
+
#
|
1639
|
+
# @return [Types::GetEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1640
|
+
#
|
1641
|
+
# * {Types::GetEnvironmentAccountConnectionOutput#environment_account_connection #environment_account_connection} => Types::EnvironmentAccountConnection
|
1642
|
+
#
|
1643
|
+
# @example Request syntax with placeholder values
|
1644
|
+
#
|
1645
|
+
# resp = client.get_environment_account_connection({
|
1646
|
+
# id: "EnvironmentAccountConnectionId", # required
|
1647
|
+
# })
|
1648
|
+
#
|
1649
|
+
# @example Response structure
|
1650
|
+
#
|
1651
|
+
# resp.environment_account_connection.arn #=> String
|
1652
|
+
# resp.environment_account_connection.environment_account_id #=> String
|
1653
|
+
# resp.environment_account_connection.environment_name #=> String
|
1654
|
+
# resp.environment_account_connection.id #=> String
|
1655
|
+
# resp.environment_account_connection.last_modified_at #=> Time
|
1656
|
+
# resp.environment_account_connection.management_account_id #=> String
|
1657
|
+
# resp.environment_account_connection.requested_at #=> Time
|
1658
|
+
# resp.environment_account_connection.role_arn #=> String
|
1659
|
+
# resp.environment_account_connection.status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
1660
|
+
#
|
1661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentAccountConnection AWS API Documentation
|
1662
|
+
#
|
1663
|
+
# @overload get_environment_account_connection(params = {})
|
1664
|
+
# @param [Hash] params ({})
|
1665
|
+
def get_environment_account_connection(params = {}, options = {})
|
1666
|
+
req = build_request(:get_environment_account_connection, params)
|
1667
|
+
req.send_request(options)
|
1668
|
+
end
|
1669
|
+
|
1670
|
+
# Get detail data for an environment template.
|
1671
|
+
#
|
1672
|
+
# @option params [required, String] :name
|
1673
|
+
# The name of the environment template that you want to get the detail
|
1674
|
+
# data for.
|
1675
|
+
#
|
1676
|
+
# @return [Types::GetEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1677
|
+
#
|
1678
|
+
# * {Types::GetEnvironmentTemplateOutput#environment_template #environment_template} => Types::EnvironmentTemplate
|
1679
|
+
#
|
1680
|
+
# @example Request syntax with placeholder values
|
1681
|
+
#
|
1682
|
+
# resp = client.get_environment_template({
|
1683
|
+
# name: "ResourceName", # required
|
1684
|
+
# })
|
1685
|
+
#
|
1686
|
+
# @example Response structure
|
1687
|
+
#
|
1688
|
+
# resp.environment_template.arn #=> String
|
1689
|
+
# resp.environment_template.created_at #=> Time
|
1690
|
+
# resp.environment_template.description #=> String
|
1691
|
+
# resp.environment_template.display_name #=> String
|
1692
|
+
# resp.environment_template.encryption_key #=> String
|
1693
|
+
# resp.environment_template.last_modified_at #=> Time
|
1694
|
+
# resp.environment_template.name #=> String
|
1695
|
+
# resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1696
|
+
# resp.environment_template.recommended_version #=> String
|
1697
|
+
#
|
1698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplate AWS API Documentation
|
1699
|
+
#
|
1700
|
+
# @overload get_environment_template(params = {})
|
1701
|
+
# @param [Hash] params ({})
|
1702
|
+
def get_environment_template(params = {}, options = {})
|
1703
|
+
req = build_request(:get_environment_template, params)
|
1704
|
+
req.send_request(options)
|
1705
|
+
end
|
1706
|
+
|
1707
|
+
# View detail data for a major or minor version of an environment
|
1708
|
+
# template.
|
1709
|
+
#
|
1710
|
+
# @option params [required, String] :major_version
|
1711
|
+
# To view environment template major version detail data, include
|
1712
|
+
# `majorVersion`.
|
1713
|
+
#
|
1714
|
+
# @option params [required, String] :minor_version
|
1715
|
+
# To view environment template minor version detail data, include
|
1716
|
+
# `minorVersion`.
|
1717
|
+
#
|
1718
|
+
# @option params [required, String] :template_name
|
1719
|
+
# The name of the environment template.
|
1720
|
+
#
|
1721
|
+
# @return [Types::GetEnvironmentTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1722
|
+
#
|
1723
|
+
# * {Types::GetEnvironmentTemplateVersionOutput#environment_template_version #environment_template_version} => Types::EnvironmentTemplateVersion
|
1724
|
+
#
|
1725
|
+
# @example Request syntax with placeholder values
|
1726
|
+
#
|
1727
|
+
# resp = client.get_environment_template_version({
|
1728
|
+
# major_version: "TemplateVersionPart", # required
|
1729
|
+
# minor_version: "TemplateVersionPart", # required
|
1730
|
+
# template_name: "ResourceName", # required
|
1731
|
+
# })
|
1732
|
+
#
|
1733
|
+
# @example Response structure
|
1734
|
+
#
|
1735
|
+
# resp.environment_template_version.arn #=> String
|
1736
|
+
# resp.environment_template_version.created_at #=> Time
|
1737
|
+
# resp.environment_template_version.description #=> String
|
1738
|
+
# resp.environment_template_version.last_modified_at #=> Time
|
1739
|
+
# resp.environment_template_version.major_version #=> String
|
1740
|
+
# resp.environment_template_version.minor_version #=> String
|
1741
|
+
# resp.environment_template_version.recommended_minor_version #=> String
|
1742
|
+
# resp.environment_template_version.schema #=> String
|
1743
|
+
# resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1744
|
+
# resp.environment_template_version.status_message #=> String
|
1745
|
+
# resp.environment_template_version.template_name #=> String
|
1746
|
+
#
|
1747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetEnvironmentTemplateVersion AWS API Documentation
|
1748
|
+
#
|
1749
|
+
# @overload get_environment_template_version(params = {})
|
1750
|
+
# @param [Hash] params ({})
|
1751
|
+
def get_environment_template_version(params = {}, options = {})
|
1752
|
+
req = build_request(:get_environment_template_version, params)
|
1753
|
+
req.send_request(options)
|
1754
|
+
end
|
1755
|
+
|
1756
|
+
# Get detail data for a service.
|
1757
|
+
#
|
1758
|
+
# @option params [required, String] :name
|
1759
|
+
# The name of the service that you want to get the detail data for.
|
1760
|
+
#
|
1761
|
+
# @return [Types::GetServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1762
|
+
#
|
1763
|
+
# * {Types::GetServiceOutput#service #service} => Types::Service
|
1764
|
+
#
|
1765
|
+
# @example Request syntax with placeholder values
|
1766
|
+
#
|
1767
|
+
# resp = client.get_service({
|
1768
|
+
# name: "ResourceName", # required
|
1769
|
+
# })
|
1770
|
+
#
|
1771
|
+
# @example Response structure
|
1772
|
+
#
|
1773
|
+
# resp.service.arn #=> String
|
1774
|
+
# resp.service.branch_name #=> String
|
1775
|
+
# resp.service.created_at #=> Time
|
1776
|
+
# resp.service.description #=> String
|
1777
|
+
# resp.service.last_modified_at #=> Time
|
1778
|
+
# resp.service.name #=> String
|
1779
|
+
# resp.service.pipeline.arn #=> String
|
1780
|
+
# resp.service.pipeline.created_at #=> Time
|
1781
|
+
# resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1782
|
+
# resp.service.pipeline.deployment_status_message #=> String
|
1783
|
+
# resp.service.pipeline.last_deployment_attempted_at #=> Time
|
1784
|
+
# resp.service.pipeline.last_deployment_succeeded_at #=> Time
|
1785
|
+
# resp.service.pipeline.spec #=> String
|
1786
|
+
# resp.service.pipeline.template_major_version #=> String
|
1787
|
+
# resp.service.pipeline.template_minor_version #=> String
|
1788
|
+
# resp.service.pipeline.template_name #=> String
|
1789
|
+
# resp.service.repository_connection_arn #=> String
|
1790
|
+
# resp.service.repository_id #=> String
|
1791
|
+
# resp.service.spec #=> String
|
1792
|
+
# resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
|
1793
|
+
# resp.service.status_message #=> String
|
1794
|
+
# resp.service.template_name #=> String
|
1795
|
+
#
|
1796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetService AWS API Documentation
|
1797
|
+
#
|
1798
|
+
# @overload get_service(params = {})
|
1799
|
+
# @param [Hash] params ({})
|
1800
|
+
def get_service(params = {}, options = {})
|
1801
|
+
req = build_request(:get_service, params)
|
1802
|
+
req.send_request(options)
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Get detail data for a service instance. A service instance is an
|
1806
|
+
# instantiation of service template, which is running in a specific
|
1807
|
+
# environment.
|
1808
|
+
#
|
1809
|
+
# @option params [required, String] :name
|
1810
|
+
# The name of a service instance that you want to get the detail data
|
1811
|
+
# for.
|
1812
|
+
#
|
1813
|
+
# @option params [required, String] :service_name
|
1814
|
+
# The name of the service that the service instance belongs to.
|
1815
|
+
#
|
1816
|
+
# @return [Types::GetServiceInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1817
|
+
#
|
1818
|
+
# * {Types::GetServiceInstanceOutput#service_instance #service_instance} => Types::ServiceInstance
|
1819
|
+
#
|
1820
|
+
# @example Request syntax with placeholder values
|
1821
|
+
#
|
1822
|
+
# resp = client.get_service_instance({
|
1823
|
+
# name: "ResourceName", # required
|
1824
|
+
# service_name: "ResourceName", # required
|
1825
|
+
# })
|
1826
|
+
#
|
1827
|
+
# @example Response structure
|
1828
|
+
#
|
1829
|
+
# resp.service_instance.arn #=> String
|
1830
|
+
# resp.service_instance.created_at #=> Time
|
1831
|
+
# resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
1832
|
+
# resp.service_instance.deployment_status_message #=> String
|
1833
|
+
# resp.service_instance.environment_name #=> String
|
1834
|
+
# resp.service_instance.last_deployment_attempted_at #=> Time
|
1835
|
+
# resp.service_instance.last_deployment_succeeded_at #=> Time
|
1836
|
+
# resp.service_instance.name #=> String
|
1837
|
+
# resp.service_instance.service_name #=> String
|
1838
|
+
# resp.service_instance.spec #=> String
|
1839
|
+
# resp.service_instance.template_major_version #=> String
|
1840
|
+
# resp.service_instance.template_minor_version #=> String
|
1841
|
+
# resp.service_instance.template_name #=> String
|
1842
|
+
#
|
1843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceInstance AWS API Documentation
|
1844
|
+
#
|
1845
|
+
# @overload get_service_instance(params = {})
|
1846
|
+
# @param [Hash] params ({})
|
1847
|
+
def get_service_instance(params = {}, options = {})
|
1848
|
+
req = build_request(:get_service_instance, params)
|
1849
|
+
req.send_request(options)
|
1850
|
+
end
|
1851
|
+
|
1852
|
+
# Get detail data for a service template.
|
1853
|
+
#
|
1854
|
+
# @option params [required, String] :name
|
1855
|
+
# The name of the service template that you want to get detail data for.
|
1856
|
+
#
|
1857
|
+
# @return [Types::GetServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1858
|
+
#
|
1859
|
+
# * {Types::GetServiceTemplateOutput#service_template #service_template} => Types::ServiceTemplate
|
1860
|
+
#
|
1861
|
+
# @example Request syntax with placeholder values
|
1862
|
+
#
|
1863
|
+
# resp = client.get_service_template({
|
1864
|
+
# name: "ResourceName", # required
|
1865
|
+
# })
|
1866
|
+
#
|
1867
|
+
# @example Response structure
|
1868
|
+
#
|
1869
|
+
# resp.service_template.arn #=> String
|
1870
|
+
# resp.service_template.created_at #=> Time
|
1871
|
+
# resp.service_template.description #=> String
|
1872
|
+
# resp.service_template.display_name #=> String
|
1873
|
+
# resp.service_template.encryption_key #=> String
|
1874
|
+
# resp.service_template.last_modified_at #=> Time
|
1875
|
+
# resp.service_template.name #=> String
|
1876
|
+
# resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
|
1877
|
+
# resp.service_template.recommended_version #=> String
|
1878
|
+
#
|
1879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplate AWS API Documentation
|
1880
|
+
#
|
1881
|
+
# @overload get_service_template(params = {})
|
1882
|
+
# @param [Hash] params ({})
|
1883
|
+
def get_service_template(params = {}, options = {})
|
1884
|
+
req = build_request(:get_service_template, params)
|
1885
|
+
req.send_request(options)
|
1886
|
+
end
|
1887
|
+
|
1888
|
+
# View detail data for a major or minor version of a service template.
|
1889
|
+
#
|
1890
|
+
# @option params [required, String] :major_version
|
1891
|
+
# To view service template major version detail data, include
|
1892
|
+
# `majorVersion`.
|
1893
|
+
#
|
1894
|
+
# @option params [required, String] :minor_version
|
1895
|
+
# To view service template minor version detail data, include
|
1896
|
+
# `minorVersion`.
|
1897
|
+
#
|
1898
|
+
# @option params [required, String] :template_name
|
1899
|
+
# The name of the service template.
|
1900
|
+
#
|
1901
|
+
# @return [Types::GetServiceTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1902
|
+
#
|
1903
|
+
# * {Types::GetServiceTemplateVersionOutput#service_template_version #service_template_version} => Types::ServiceTemplateVersion
|
1904
|
+
#
|
1905
|
+
# @example Request syntax with placeholder values
|
1906
|
+
#
|
1907
|
+
# resp = client.get_service_template_version({
|
1908
|
+
# major_version: "TemplateVersionPart", # required
|
1909
|
+
# minor_version: "TemplateVersionPart", # required
|
1910
|
+
# template_name: "ResourceName", # required
|
1911
|
+
# })
|
1912
|
+
#
|
1913
|
+
# @example Response structure
|
1914
|
+
#
|
1915
|
+
# resp.service_template_version.arn #=> String
|
1916
|
+
# resp.service_template_version.compatible_environment_templates #=> Array
|
1917
|
+
# resp.service_template_version.compatible_environment_templates[0].major_version #=> String
|
1918
|
+
# resp.service_template_version.compatible_environment_templates[0].template_name #=> String
|
1919
|
+
# resp.service_template_version.created_at #=> Time
|
1920
|
+
# resp.service_template_version.description #=> String
|
1921
|
+
# resp.service_template_version.last_modified_at #=> Time
|
1922
|
+
# resp.service_template_version.major_version #=> String
|
1923
|
+
# resp.service_template_version.minor_version #=> String
|
1924
|
+
# resp.service_template_version.recommended_minor_version #=> String
|
1925
|
+
# resp.service_template_version.schema #=> String
|
1926
|
+
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
1927
|
+
# resp.service_template_version.status_message #=> String
|
1928
|
+
# resp.service_template_version.template_name #=> String
|
1929
|
+
#
|
1930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/GetServiceTemplateVersion AWS API Documentation
|
1931
|
+
#
|
1932
|
+
# @overload get_service_template_version(params = {})
|
1933
|
+
# @param [Hash] params ({})
|
1934
|
+
def get_service_template_version(params = {}, options = {})
|
1935
|
+
req = build_request(:get_service_template_version, params)
|
1936
|
+
req.send_request(options)
|
1937
|
+
end
|
1938
|
+
|
1939
|
+
# View a list of environment account connections.
|
1940
|
+
#
|
1941
|
+
# For more information, see [Environment account
|
1942
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
1943
|
+
# in the *AWS Proton Administration guide*.
|
1944
|
+
#
|
1945
|
+
# @option params [String] :environment_name
|
1946
|
+
# The environment name that's associated with each listed environment
|
1947
|
+
# account connection.
|
1948
|
+
#
|
1949
|
+
# @option params [Integer] :max_results
|
1950
|
+
# The maximum number of environment account connections to list.
|
1951
|
+
#
|
1952
|
+
# @option params [String] :next_token
|
1953
|
+
# A token to indicate the location of the next environment account
|
1954
|
+
# connection in the array of environment account connections, after the
|
1955
|
+
# list of environment account connections that was previously requested.
|
1956
|
+
#
|
1957
|
+
# @option params [required, String] :requested_by
|
1958
|
+
# The type of account making the `ListEnvironmentAccountConnections`
|
1959
|
+
# request.
|
1960
|
+
#
|
1961
|
+
# @option params [Array<String>] :statuses
|
1962
|
+
# The status details for each listed environment account connection.
|
1963
|
+
#
|
1964
|
+
# @return [Types::ListEnvironmentAccountConnectionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1965
|
+
#
|
1966
|
+
# * {Types::ListEnvironmentAccountConnectionsOutput#environment_account_connections #environment_account_connections} => Array<Types::EnvironmentAccountConnectionSummary>
|
1967
|
+
# * {Types::ListEnvironmentAccountConnectionsOutput#next_token #next_token} => String
|
1968
|
+
#
|
1969
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1970
|
+
#
|
1971
|
+
# @example Request syntax with placeholder values
|
1972
|
+
#
|
1973
|
+
# resp = client.list_environment_account_connections({
|
1974
|
+
# environment_name: "ResourceName",
|
1975
|
+
# max_results: 1,
|
1976
|
+
# next_token: "NextToken",
|
1977
|
+
# requested_by: "MANAGEMENT_ACCOUNT", # required, accepts MANAGEMENT_ACCOUNT, ENVIRONMENT_ACCOUNT
|
1978
|
+
# statuses: ["PENDING"], # accepts PENDING, CONNECTED, REJECTED
|
1979
|
+
# })
|
1980
|
+
#
|
1981
|
+
# @example Response structure
|
1982
|
+
#
|
1983
|
+
# resp.environment_account_connections #=> Array
|
1984
|
+
# resp.environment_account_connections[0].arn #=> String
|
1985
|
+
# resp.environment_account_connections[0].environment_account_id #=> String
|
1986
|
+
# resp.environment_account_connections[0].environment_name #=> String
|
1987
|
+
# resp.environment_account_connections[0].id #=> String
|
1988
|
+
# resp.environment_account_connections[0].last_modified_at #=> Time
|
1989
|
+
# resp.environment_account_connections[0].management_account_id #=> String
|
1990
|
+
# resp.environment_account_connections[0].requested_at #=> Time
|
1991
|
+
# resp.environment_account_connections[0].role_arn #=> String
|
1992
|
+
# resp.environment_account_connections[0].status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
1993
|
+
# resp.next_token #=> String
|
1994
|
+
#
|
1995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentAccountConnections AWS API Documentation
|
1996
|
+
#
|
1997
|
+
# @overload list_environment_account_connections(params = {})
|
1998
|
+
# @param [Hash] params ({})
|
1999
|
+
def list_environment_account_connections(params = {}, options = {})
|
2000
|
+
req = build_request(:list_environment_account_connections, params)
|
2001
|
+
req.send_request(options)
|
2002
|
+
end
|
2003
|
+
|
2004
|
+
# List major or minor versions of an environment template with detail
|
2005
|
+
# data.
|
2006
|
+
#
|
2007
|
+
# @option params [String] :major_version
|
2008
|
+
# To view a list of minor of versions under a major version of an
|
2009
|
+
# environment template, include `majorVersion`.
|
2010
|
+
#
|
2011
|
+
# To view a list of major versions of an environment template, *exclude*
|
2012
|
+
# `majorVersion`.
|
2013
|
+
#
|
2014
|
+
# @option params [Integer] :max_results
|
2015
|
+
# The maximum number of major or minor versions of an environment
|
2016
|
+
# template to list.
|
2017
|
+
#
|
2018
|
+
# @option params [String] :next_token
|
2019
|
+
# A token to indicate the location of the next major or minor version in
|
2020
|
+
# the array of major or minor versions of an environment template, after
|
2021
|
+
# the list of major or minor versions that was previously requested.
|
2022
|
+
#
|
2023
|
+
# @option params [required, String] :template_name
|
2024
|
+
# The name of the environment template.
|
2025
|
+
#
|
2026
|
+
# @return [Types::ListEnvironmentTemplateVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2027
|
+
#
|
2028
|
+
# * {Types::ListEnvironmentTemplateVersionsOutput#next_token #next_token} => String
|
2029
|
+
# * {Types::ListEnvironmentTemplateVersionsOutput#template_versions #template_versions} => Array<Types::EnvironmentTemplateVersionSummary>
|
2030
|
+
#
|
2031
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2032
|
+
#
|
2033
|
+
# @example Request syntax with placeholder values
|
2034
|
+
#
|
2035
|
+
# resp = client.list_environment_template_versions({
|
2036
|
+
# major_version: "TemplateVersionPart",
|
2037
|
+
# max_results: 1,
|
2038
|
+
# next_token: "NextToken",
|
2039
|
+
# template_name: "ResourceName", # required
|
2040
|
+
# })
|
2041
|
+
#
|
2042
|
+
# @example Response structure
|
2043
|
+
#
|
2044
|
+
# resp.next_token #=> String
|
2045
|
+
# resp.template_versions #=> Array
|
2046
|
+
# resp.template_versions[0].arn #=> String
|
2047
|
+
# resp.template_versions[0].created_at #=> Time
|
2048
|
+
# resp.template_versions[0].description #=> String
|
2049
|
+
# resp.template_versions[0].last_modified_at #=> Time
|
2050
|
+
# resp.template_versions[0].major_version #=> String
|
2051
|
+
# resp.template_versions[0].minor_version #=> String
|
2052
|
+
# resp.template_versions[0].recommended_minor_version #=> String
|
2053
|
+
# resp.template_versions[0].status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
2054
|
+
# resp.template_versions[0].status_message #=> String
|
2055
|
+
# resp.template_versions[0].template_name #=> String
|
2056
|
+
#
|
2057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplateVersions AWS API Documentation
|
2058
|
+
#
|
2059
|
+
# @overload list_environment_template_versions(params = {})
|
2060
|
+
# @param [Hash] params ({})
|
2061
|
+
def list_environment_template_versions(params = {}, options = {})
|
2062
|
+
req = build_request(:list_environment_template_versions, params)
|
2063
|
+
req.send_request(options)
|
2064
|
+
end
|
2065
|
+
|
2066
|
+
# List environment templates.
|
2067
|
+
#
|
2068
|
+
# @option params [Integer] :max_results
|
2069
|
+
# The maximum number of environment templates to list.
|
2070
|
+
#
|
2071
|
+
# @option params [String] :next_token
|
2072
|
+
# A token to indicate the location of the next environment template in
|
2073
|
+
# the array of environment templates, after the list of environment
|
2074
|
+
# templates that was previously requested.
|
2075
|
+
#
|
2076
|
+
# @return [Types::ListEnvironmentTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2077
|
+
#
|
2078
|
+
# * {Types::ListEnvironmentTemplatesOutput#next_token #next_token} => String
|
2079
|
+
# * {Types::ListEnvironmentTemplatesOutput#templates #templates} => Array<Types::EnvironmentTemplateSummary>
|
2080
|
+
#
|
2081
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2082
|
+
#
|
2083
|
+
# @example Request syntax with placeholder values
|
2084
|
+
#
|
2085
|
+
# resp = client.list_environment_templates({
|
2086
|
+
# max_results: 1,
|
2087
|
+
# next_token: "NextToken",
|
2088
|
+
# })
|
2089
|
+
#
|
2090
|
+
# @example Response structure
|
2091
|
+
#
|
2092
|
+
# resp.next_token #=> String
|
2093
|
+
# resp.templates #=> Array
|
2094
|
+
# resp.templates[0].arn #=> String
|
2095
|
+
# resp.templates[0].created_at #=> Time
|
2096
|
+
# resp.templates[0].description #=> String
|
2097
|
+
# resp.templates[0].display_name #=> String
|
2098
|
+
# resp.templates[0].last_modified_at #=> Time
|
2099
|
+
# resp.templates[0].name #=> String
|
2100
|
+
# resp.templates[0].provisioning #=> String, one of "CUSTOMER_MANAGED"
|
2101
|
+
# resp.templates[0].recommended_version #=> String
|
2102
|
+
#
|
2103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironmentTemplates AWS API Documentation
|
2104
|
+
#
|
2105
|
+
# @overload list_environment_templates(params = {})
|
2106
|
+
# @param [Hash] params ({})
|
2107
|
+
def list_environment_templates(params = {}, options = {})
|
2108
|
+
req = build_request(:list_environment_templates, params)
|
2109
|
+
req.send_request(options)
|
2110
|
+
end
|
2111
|
+
|
2112
|
+
# List environments with detail data summaries.
|
2113
|
+
#
|
2114
|
+
# @option params [Array<Types::EnvironmentTemplateFilter>] :environment_templates
|
2115
|
+
# An array of the versions of the environment template.
|
2116
|
+
#
|
2117
|
+
# @option params [Integer] :max_results
|
2118
|
+
# The maximum number of environments to list.
|
2119
|
+
#
|
2120
|
+
# @option params [String] :next_token
|
2121
|
+
# A token to indicate the location of the next environment in the array
|
2122
|
+
# of environments, after the list of environments that was previously
|
2123
|
+
# requested.
|
2124
|
+
#
|
2125
|
+
# @return [Types::ListEnvironmentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2126
|
+
#
|
2127
|
+
# * {Types::ListEnvironmentsOutput#environments #environments} => Array<Types::EnvironmentSummary>
|
2128
|
+
# * {Types::ListEnvironmentsOutput#next_token #next_token} => String
|
2129
|
+
#
|
2130
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2131
|
+
#
|
2132
|
+
# @example Request syntax with placeholder values
|
2133
|
+
#
|
2134
|
+
# resp = client.list_environments({
|
2135
|
+
# environment_templates: [
|
2136
|
+
# {
|
2137
|
+
# major_version: "TemplateVersionPart", # required
|
2138
|
+
# template_name: "ResourceName", # required
|
2139
|
+
# },
|
2140
|
+
# ],
|
2141
|
+
# max_results: 1,
|
2142
|
+
# next_token: "NextToken",
|
2143
|
+
# })
|
2144
|
+
#
|
2145
|
+
# @example Response structure
|
2146
|
+
#
|
2147
|
+
# resp.environments #=> Array
|
2148
|
+
# resp.environments[0].arn #=> String
|
2149
|
+
# resp.environments[0].created_at #=> Time
|
2150
|
+
# resp.environments[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
2151
|
+
# resp.environments[0].deployment_status_message #=> String
|
2152
|
+
# resp.environments[0].description #=> String
|
2153
|
+
# resp.environments[0].environment_account_connection_id #=> String
|
2154
|
+
# resp.environments[0].environment_account_id #=> String
|
2155
|
+
# resp.environments[0].last_deployment_attempted_at #=> Time
|
2156
|
+
# resp.environments[0].last_deployment_succeeded_at #=> Time
|
2157
|
+
# resp.environments[0].name #=> String
|
2158
|
+
# resp.environments[0].proton_service_role_arn #=> String
|
2159
|
+
# resp.environments[0].provisioning #=> String, one of "CUSTOMER_MANAGED"
|
2160
|
+
# resp.environments[0].template_major_version #=> String
|
2161
|
+
# resp.environments[0].template_minor_version #=> String
|
2162
|
+
# resp.environments[0].template_name #=> String
|
2163
|
+
# resp.next_token #=> String
|
2164
|
+
#
|
2165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListEnvironments AWS API Documentation
|
2166
|
+
#
|
2167
|
+
# @overload list_environments(params = {})
|
2168
|
+
# @param [Hash] params ({})
|
2169
|
+
def list_environments(params = {}, options = {})
|
2170
|
+
req = build_request(:list_environments, params)
|
2171
|
+
req.send_request(options)
|
2172
|
+
end
|
2173
|
+
|
2174
|
+
# List service instances with summaries of detail data.
|
2175
|
+
#
|
2176
|
+
# @option params [Integer] :max_results
|
2177
|
+
# The maximum number of service instances to list.
|
2178
|
+
#
|
2179
|
+
# @option params [String] :next_token
|
2180
|
+
# A token to indicate the location of the next service in the array of
|
2181
|
+
# service instances, after the list of service instances that was
|
2182
|
+
# previously requested.
|
2183
|
+
#
|
2184
|
+
# @option params [String] :service_name
|
2185
|
+
# The name of the service that the service instance belongs to.
|
2186
|
+
#
|
2187
|
+
# @return [Types::ListServiceInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2188
|
+
#
|
2189
|
+
# * {Types::ListServiceInstancesOutput#next_token #next_token} => String
|
2190
|
+
# * {Types::ListServiceInstancesOutput#service_instances #service_instances} => Array<Types::ServiceInstanceSummary>
|
2191
|
+
#
|
2192
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2193
|
+
#
|
2194
|
+
# @example Request syntax with placeholder values
|
2195
|
+
#
|
2196
|
+
# resp = client.list_service_instances({
|
2197
|
+
# max_results: 1,
|
2198
|
+
# next_token: "NextToken",
|
2199
|
+
# service_name: "ResourceName",
|
2200
|
+
# })
|
2201
|
+
#
|
2202
|
+
# @example Response structure
|
2203
|
+
#
|
2204
|
+
# resp.next_token #=> String
|
2205
|
+
# resp.service_instances #=> Array
|
2206
|
+
# resp.service_instances[0].arn #=> String
|
2207
|
+
# resp.service_instances[0].created_at #=> Time
|
2208
|
+
# resp.service_instances[0].deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
2209
|
+
# resp.service_instances[0].deployment_status_message #=> String
|
2210
|
+
# resp.service_instances[0].environment_name #=> String
|
2211
|
+
# resp.service_instances[0].last_deployment_attempted_at #=> Time
|
2212
|
+
# resp.service_instances[0].last_deployment_succeeded_at #=> Time
|
2213
|
+
# resp.service_instances[0].name #=> String
|
2214
|
+
# resp.service_instances[0].service_name #=> String
|
2215
|
+
# resp.service_instances[0].template_major_version #=> String
|
2216
|
+
# resp.service_instances[0].template_minor_version #=> String
|
2217
|
+
# resp.service_instances[0].template_name #=> String
|
2218
|
+
#
|
2219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceInstances AWS API Documentation
|
2220
|
+
#
|
2221
|
+
# @overload list_service_instances(params = {})
|
2222
|
+
# @param [Hash] params ({})
|
2223
|
+
def list_service_instances(params = {}, options = {})
|
2224
|
+
req = build_request(:list_service_instances, params)
|
2225
|
+
req.send_request(options)
|
2226
|
+
end
|
2227
|
+
|
2228
|
+
# List major or minor versions of a service template with detail data.
|
2229
|
+
#
|
2230
|
+
# @option params [String] :major_version
|
2231
|
+
# To view a list of minor of versions under a major version of a service
|
2232
|
+
# template, include `majorVersion`.
|
2233
|
+
#
|
2234
|
+
# To view a list of major versions of a service template, *exclude*
|
2235
|
+
# `majorVersion`.
|
2236
|
+
#
|
2237
|
+
# @option params [Integer] :max_results
|
2238
|
+
# The maximum number of major or minor versions of a service template to
|
2239
|
+
# list.
|
2240
|
+
#
|
2241
|
+
# @option params [String] :next_token
|
2242
|
+
# A token to indicate the location of the next major or minor version in
|
2243
|
+
# the array of major or minor versions of a service template, after the
|
2244
|
+
# list of major or minor versions that was previously requested.
|
2245
|
+
#
|
2246
|
+
# @option params [required, String] :template_name
|
2247
|
+
# The name of the service template.
|
2248
|
+
#
|
2249
|
+
# @return [Types::ListServiceTemplateVersionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2250
|
+
#
|
2251
|
+
# * {Types::ListServiceTemplateVersionsOutput#next_token #next_token} => String
|
2252
|
+
# * {Types::ListServiceTemplateVersionsOutput#template_versions #template_versions} => Array<Types::ServiceTemplateVersionSummary>
|
2253
|
+
#
|
2254
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2255
|
+
#
|
2256
|
+
# @example Request syntax with placeholder values
|
2257
|
+
#
|
2258
|
+
# resp = client.list_service_template_versions({
|
2259
|
+
# major_version: "TemplateVersionPart",
|
2260
|
+
# max_results: 1,
|
2261
|
+
# next_token: "NextToken",
|
2262
|
+
# template_name: "ResourceName", # required
|
2263
|
+
# })
|
2264
|
+
#
|
2265
|
+
# @example Response structure
|
2266
|
+
#
|
2267
|
+
# resp.next_token #=> String
|
2268
|
+
# resp.template_versions #=> Array
|
2269
|
+
# resp.template_versions[0].arn #=> String
|
2270
|
+
# resp.template_versions[0].created_at #=> Time
|
2271
|
+
# resp.template_versions[0].description #=> String
|
2272
|
+
# resp.template_versions[0].last_modified_at #=> Time
|
2273
|
+
# resp.template_versions[0].major_version #=> String
|
2274
|
+
# resp.template_versions[0].minor_version #=> String
|
2275
|
+
# resp.template_versions[0].recommended_minor_version #=> String
|
2276
|
+
# resp.template_versions[0].status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
2277
|
+
# resp.template_versions[0].status_message #=> String
|
2278
|
+
# resp.template_versions[0].template_name #=> String
|
2279
|
+
#
|
2280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplateVersions AWS API Documentation
|
2281
|
+
#
|
2282
|
+
# @overload list_service_template_versions(params = {})
|
2283
|
+
# @param [Hash] params ({})
|
2284
|
+
def list_service_template_versions(params = {}, options = {})
|
2285
|
+
req = build_request(:list_service_template_versions, params)
|
2286
|
+
req.send_request(options)
|
2287
|
+
end
|
2288
|
+
|
2289
|
+
# List service templates with detail data.
|
2290
|
+
#
|
2291
|
+
# @option params [Integer] :max_results
|
2292
|
+
# The maximum number of service templates to list.
|
2293
|
+
#
|
2294
|
+
# @option params [String] :next_token
|
2295
|
+
# A token to indicate the location of the next service template in the
|
2296
|
+
# array of service templates, after the list of service templates
|
2297
|
+
# previously requested.
|
2298
|
+
#
|
2299
|
+
# @return [Types::ListServiceTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2300
|
+
#
|
2301
|
+
# * {Types::ListServiceTemplatesOutput#next_token #next_token} => String
|
2302
|
+
# * {Types::ListServiceTemplatesOutput#templates #templates} => Array<Types::ServiceTemplateSummary>
|
2303
|
+
#
|
2304
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2305
|
+
#
|
2306
|
+
# @example Request syntax with placeholder values
|
2307
|
+
#
|
2308
|
+
# resp = client.list_service_templates({
|
2309
|
+
# max_results: 1,
|
2310
|
+
# next_token: "NextToken",
|
2311
|
+
# })
|
2312
|
+
#
|
2313
|
+
# @example Response structure
|
2314
|
+
#
|
2315
|
+
# resp.next_token #=> String
|
2316
|
+
# resp.templates #=> Array
|
2317
|
+
# resp.templates[0].arn #=> String
|
2318
|
+
# resp.templates[0].created_at #=> Time
|
2319
|
+
# resp.templates[0].description #=> String
|
2320
|
+
# resp.templates[0].display_name #=> String
|
2321
|
+
# resp.templates[0].last_modified_at #=> Time
|
2322
|
+
# resp.templates[0].name #=> String
|
2323
|
+
# resp.templates[0].pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
|
2324
|
+
# resp.templates[0].recommended_version #=> String
|
2325
|
+
#
|
2326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServiceTemplates AWS API Documentation
|
2327
|
+
#
|
2328
|
+
# @overload list_service_templates(params = {})
|
2329
|
+
# @param [Hash] params ({})
|
2330
|
+
def list_service_templates(params = {}, options = {})
|
2331
|
+
req = build_request(:list_service_templates, params)
|
2332
|
+
req.send_request(options)
|
2333
|
+
end
|
2334
|
+
|
2335
|
+
# List services with summaries of detail data.
|
2336
|
+
#
|
2337
|
+
# @option params [Integer] :max_results
|
2338
|
+
# The maximum number of services to list.
|
2339
|
+
#
|
2340
|
+
# @option params [String] :next_token
|
2341
|
+
# A token to indicate the location of the next service in the array of
|
2342
|
+
# services, after the list of services that was previously requested.
|
2343
|
+
#
|
2344
|
+
# @return [Types::ListServicesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2345
|
+
#
|
2346
|
+
# * {Types::ListServicesOutput#next_token #next_token} => String
|
2347
|
+
# * {Types::ListServicesOutput#services #services} => Array<Types::ServiceSummary>
|
2348
|
+
#
|
2349
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2350
|
+
#
|
2351
|
+
# @example Request syntax with placeholder values
|
2352
|
+
#
|
2353
|
+
# resp = client.list_services({
|
2354
|
+
# max_results: 1,
|
2355
|
+
# next_token: "NextToken",
|
2356
|
+
# })
|
2357
|
+
#
|
2358
|
+
# @example Response structure
|
2359
|
+
#
|
2360
|
+
# resp.next_token #=> String
|
2361
|
+
# resp.services #=> Array
|
2362
|
+
# resp.services[0].arn #=> String
|
2363
|
+
# resp.services[0].created_at #=> Time
|
2364
|
+
# resp.services[0].description #=> String
|
2365
|
+
# resp.services[0].last_modified_at #=> Time
|
2366
|
+
# resp.services[0].name #=> String
|
2367
|
+
# resp.services[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
|
2368
|
+
# resp.services[0].status_message #=> String
|
2369
|
+
# resp.services[0].template_name #=> String
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListServices AWS API Documentation
|
2372
|
+
#
|
2373
|
+
# @overload list_services(params = {})
|
2374
|
+
# @param [Hash] params ({})
|
2375
|
+
def list_services(params = {}, options = {})
|
2376
|
+
req = build_request(:list_services, params)
|
2377
|
+
req.send_request(options)
|
2378
|
+
end
|
2379
|
+
|
2380
|
+
# List tags for a resource. For more information, see *AWS Proton
|
2381
|
+
# resources and tagging* in the [AWS Proton Administration Guide][1] or
|
2382
|
+
# [AWS Proton User Guide][2].
|
2383
|
+
#
|
2384
|
+
#
|
2385
|
+
#
|
2386
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
2387
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
2388
|
+
#
|
2389
|
+
# @option params [Integer] :max_results
|
2390
|
+
# The maximum number of tags to list.
|
2391
|
+
#
|
2392
|
+
# @option params [String] :next_token
|
2393
|
+
# A token to indicate the location of the next resource tag in the array
|
2394
|
+
# of resource tags, after the list of resource tags that was previously
|
2395
|
+
# requested.
|
2396
|
+
#
|
2397
|
+
# @option params [required, String] :resource_arn
|
2398
|
+
# The ARN of the resource for the listed tags.
|
2399
|
+
#
|
2400
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2401
|
+
#
|
2402
|
+
# * {Types::ListTagsForResourceOutput#next_token #next_token} => String
|
2403
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Array<Types::Tag>
|
2404
|
+
#
|
2405
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2406
|
+
#
|
2407
|
+
# @example Request syntax with placeholder values
|
2408
|
+
#
|
2409
|
+
# resp = client.list_tags_for_resource({
|
2410
|
+
# max_results: 1,
|
2411
|
+
# next_token: "String",
|
2412
|
+
# resource_arn: "Arn", # required
|
2413
|
+
# })
|
2414
|
+
#
|
2415
|
+
# @example Response structure
|
2416
|
+
#
|
2417
|
+
# resp.next_token #=> String
|
2418
|
+
# resp.tags #=> Array
|
2419
|
+
# resp.tags[0].key #=> String
|
2420
|
+
# resp.tags[0].value #=> String
|
2421
|
+
#
|
2422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListTagsForResource AWS API Documentation
|
2423
|
+
#
|
2424
|
+
# @overload list_tags_for_resource(params = {})
|
2425
|
+
# @param [Hash] params ({})
|
2426
|
+
def list_tags_for_resource(params = {}, options = {})
|
2427
|
+
req = build_request(:list_tags_for_resource, params)
|
2428
|
+
req.send_request(options)
|
2429
|
+
end
|
2430
|
+
|
2431
|
+
# In a management account, reject an environment account connection from
|
2432
|
+
# another environment account.
|
2433
|
+
#
|
2434
|
+
# After you reject an environment account connection request, you
|
2435
|
+
# *won’t* be able to accept or use the rejected environment account
|
2436
|
+
# connection.
|
2437
|
+
#
|
2438
|
+
# You *can’t* reject an environment account connection that is connected
|
2439
|
+
# to an environment.
|
2440
|
+
#
|
2441
|
+
# For more information, see [Environment account
|
2442
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
2443
|
+
# in the *AWS Proton Administration guide*.
|
2444
|
+
#
|
2445
|
+
# @option params [required, String] :id
|
2446
|
+
# The ID of the environment account connection to reject.
|
2447
|
+
#
|
2448
|
+
# @return [Types::RejectEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2449
|
+
#
|
2450
|
+
# * {Types::RejectEnvironmentAccountConnectionOutput#environment_account_connection #environment_account_connection} => Types::EnvironmentAccountConnection
|
2451
|
+
#
|
2452
|
+
# @example Request syntax with placeholder values
|
2453
|
+
#
|
2454
|
+
# resp = client.reject_environment_account_connection({
|
2455
|
+
# id: "EnvironmentAccountConnectionId", # required
|
2456
|
+
# })
|
2457
|
+
#
|
2458
|
+
# @example Response structure
|
2459
|
+
#
|
2460
|
+
# resp.environment_account_connection.arn #=> String
|
2461
|
+
# resp.environment_account_connection.environment_account_id #=> String
|
2462
|
+
# resp.environment_account_connection.environment_name #=> String
|
2463
|
+
# resp.environment_account_connection.id #=> String
|
2464
|
+
# resp.environment_account_connection.last_modified_at #=> Time
|
2465
|
+
# resp.environment_account_connection.management_account_id #=> String
|
2466
|
+
# resp.environment_account_connection.requested_at #=> Time
|
2467
|
+
# resp.environment_account_connection.role_arn #=> String
|
2468
|
+
# resp.environment_account_connection.status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
2469
|
+
#
|
2470
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/RejectEnvironmentAccountConnection AWS API Documentation
|
2471
|
+
#
|
2472
|
+
# @overload reject_environment_account_connection(params = {})
|
2473
|
+
# @param [Hash] params ({})
|
2474
|
+
def reject_environment_account_connection(params = {}, options = {})
|
2475
|
+
req = build_request(:reject_environment_account_connection, params)
|
2476
|
+
req.send_request(options)
|
2477
|
+
end
|
2478
|
+
|
2479
|
+
# Tag a resource. For more information, see *AWS Proton resources and
|
2480
|
+
# tagging* in the [AWS Proton Administration Guide][1] or [AWS Proton
|
2481
|
+
# User Guide][2].
|
2482
|
+
#
|
2483
|
+
#
|
2484
|
+
#
|
2485
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
2486
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
2487
|
+
#
|
2488
|
+
# @option params [required, String] :resource_arn
|
2489
|
+
# The Amazon Resource Name (ARN) of the resource that the resource tag
|
2490
|
+
# is applied to.
|
2491
|
+
#
|
2492
|
+
# @option params [required, Array<Types::Tag>] :tags
|
2493
|
+
# An array of resource tags to apply to a resource.
|
2494
|
+
#
|
2495
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2496
|
+
#
|
2497
|
+
# @example Request syntax with placeholder values
|
2498
|
+
#
|
2499
|
+
# resp = client.tag_resource({
|
2500
|
+
# resource_arn: "Arn", # required
|
2501
|
+
# tags: [ # required
|
2502
|
+
# {
|
2503
|
+
# key: "TagKey", # required
|
2504
|
+
# value: "TagValue", # required
|
2505
|
+
# },
|
2506
|
+
# ],
|
2507
|
+
# })
|
2508
|
+
#
|
2509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/TagResource AWS API Documentation
|
2510
|
+
#
|
2511
|
+
# @overload tag_resource(params = {})
|
2512
|
+
# @param [Hash] params ({})
|
2513
|
+
def tag_resource(params = {}, options = {})
|
2514
|
+
req = build_request(:tag_resource, params)
|
2515
|
+
req.send_request(options)
|
2516
|
+
end
|
2517
|
+
|
2518
|
+
# Remove a tag from a resource. For more information, see *AWS Proton
|
2519
|
+
# resources and tagging* in the [AWS Proton Administration Guide][1] or
|
2520
|
+
# [AWS Proton User Guide][2].
|
2521
|
+
#
|
2522
|
+
#
|
2523
|
+
#
|
2524
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/resources.html
|
2525
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/resources.html
|
2526
|
+
#
|
2527
|
+
# @option params [required, String] :resource_arn
|
2528
|
+
# The Amazon Resource Name (ARN) of the resource that the tag is to be
|
2529
|
+
# removed from.
|
2530
|
+
#
|
2531
|
+
# @option params [required, Array<String>] :tag_keys
|
2532
|
+
# An array of tag keys indicating the resource tags to be removed from
|
2533
|
+
# the resource.
|
2534
|
+
#
|
2535
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2536
|
+
#
|
2537
|
+
# @example Request syntax with placeholder values
|
2538
|
+
#
|
2539
|
+
# resp = client.untag_resource({
|
2540
|
+
# resource_arn: "Arn", # required
|
2541
|
+
# tag_keys: ["TagKey"], # required
|
2542
|
+
# })
|
2543
|
+
#
|
2544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UntagResource AWS API Documentation
|
2545
|
+
#
|
2546
|
+
# @overload untag_resource(params = {})
|
2547
|
+
# @param [Hash] params ({})
|
2548
|
+
def untag_resource(params = {}, options = {})
|
2549
|
+
req = build_request(:untag_resource, params)
|
2550
|
+
req.send_request(options)
|
2551
|
+
end
|
2552
|
+
|
2553
|
+
# Update the AWS Proton pipeline service account settings.
|
2554
|
+
#
|
2555
|
+
# @option params [String] :pipeline_service_role_arn
|
2556
|
+
# The Amazon Resource Name (ARN) of the AWS Proton pipeline service
|
2557
|
+
# role.
|
2558
|
+
#
|
2559
|
+
# @return [Types::UpdateAccountSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2560
|
+
#
|
2561
|
+
# * {Types::UpdateAccountSettingsOutput#account_settings #account_settings} => Types::AccountSettings
|
2562
|
+
#
|
2563
|
+
# @example Request syntax with placeholder values
|
2564
|
+
#
|
2565
|
+
# resp = client.update_account_settings({
|
2566
|
+
# pipeline_service_role_arn: "Arn",
|
2567
|
+
# })
|
2568
|
+
#
|
2569
|
+
# @example Response structure
|
2570
|
+
#
|
2571
|
+
# resp.account_settings.pipeline_service_role_arn #=> String
|
2572
|
+
#
|
2573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateAccountSettings AWS API Documentation
|
2574
|
+
#
|
2575
|
+
# @overload update_account_settings(params = {})
|
2576
|
+
# @param [Hash] params ({})
|
2577
|
+
def update_account_settings(params = {}, options = {})
|
2578
|
+
req = build_request(:update_account_settings, params)
|
2579
|
+
req.send_request(options)
|
2580
|
+
end
|
2581
|
+
|
2582
|
+
# Update an environment.
|
2583
|
+
#
|
2584
|
+
# If the environment is associated with an environment account
|
2585
|
+
# connection, *don't* update or include the `protonServiceRoleArn`
|
2586
|
+
# parameter to update or connect to an environment account connection.
|
2587
|
+
#
|
2588
|
+
# You can only update to a new environment account connection if it was
|
2589
|
+
# created in the same environment account that the current environment
|
2590
|
+
# account connection was created in and associated with the current
|
2591
|
+
# environment.
|
2592
|
+
#
|
2593
|
+
# If the environment *isn't* associated with an environment account
|
2594
|
+
# connection, *don't* update or include the
|
2595
|
+
# `environmentAccountConnectionId` parameter to update or connect to an
|
2596
|
+
# environment account connection.
|
2597
|
+
#
|
2598
|
+
# You can update either the `environmentAccountConnectionId` or
|
2599
|
+
# `protonServiceRoleArn` parameter and value. You can’t update both.
|
2600
|
+
#
|
2601
|
+
# There are four modes for updating an environment as described in the
|
2602
|
+
# following. The `deploymentType` field defines the mode.
|
2603
|
+
#
|
2604
|
+
#
|
2605
|
+
#
|
2606
|
+
# : `NONE`
|
2607
|
+
#
|
2608
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
2609
|
+
# metadata parameters are updated.
|
2610
|
+
#
|
2611
|
+
#
|
2612
|
+
#
|
2613
|
+
# : `CURRENT_VERSION`
|
2614
|
+
#
|
2615
|
+
# In this mode, the environment is deployed and updated with the new
|
2616
|
+
# spec that you provide. Only requested parameters are updated.
|
2617
|
+
# *Don’t* include minor or major version parameters when you use this
|
2618
|
+
# `deployment-type`.
|
2619
|
+
#
|
2620
|
+
#
|
2621
|
+
#
|
2622
|
+
# : `MINOR_VERSION`
|
2623
|
+
#
|
2624
|
+
# In this mode, the environment is deployed and updated with the
|
2625
|
+
# published, recommended (latest) minor version of the current major
|
2626
|
+
# version in use, by default. You can also specify a different minor
|
2627
|
+
# version of the current major version in use.
|
2628
|
+
#
|
2629
|
+
#
|
2630
|
+
#
|
2631
|
+
# : `MAJOR_VERSION`
|
2632
|
+
#
|
2633
|
+
# In this mode, the environment is deployed and updated with the
|
2634
|
+
# published, recommended (latest) major and minor version of the
|
2635
|
+
# current template, by default. You can also specify a different major
|
2636
|
+
# version that's higher than the major version in use and a minor
|
2637
|
+
# version (optional).
|
2638
|
+
#
|
2639
|
+
# @option params [required, String] :deployment_type
|
2640
|
+
# There are four modes for updating an environment as described in the
|
2641
|
+
# following. The `deploymentType` field defines the mode.
|
2642
|
+
#
|
2643
|
+
#
|
2644
|
+
#
|
2645
|
+
# : `NONE`
|
2646
|
+
#
|
2647
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
2648
|
+
# metadata parameters are updated.
|
2649
|
+
#
|
2650
|
+
#
|
2651
|
+
#
|
2652
|
+
# : `CURRENT_VERSION`
|
2653
|
+
#
|
2654
|
+
# In this mode, the environment is deployed and updated with the new
|
2655
|
+
# spec that you provide. Only requested parameters are updated.
|
2656
|
+
# *Don’t* include minor or major version parameters when you use this
|
2657
|
+
# `deployment-type`.
|
2658
|
+
#
|
2659
|
+
#
|
2660
|
+
#
|
2661
|
+
# : `MINOR_VERSION`
|
2662
|
+
#
|
2663
|
+
# In this mode, the environment is deployed and updated with the
|
2664
|
+
# published, recommended (latest) minor version of the current major
|
2665
|
+
# version in use, by default. You can also specify a different minor
|
2666
|
+
# version of the current major version in use.
|
2667
|
+
#
|
2668
|
+
#
|
2669
|
+
#
|
2670
|
+
# : `MAJOR_VERSION`
|
2671
|
+
#
|
2672
|
+
# In this mode, the environment is deployed and updated with the
|
2673
|
+
# published, recommended (latest) major and minor version of the
|
2674
|
+
# current template, by default. You can also specify a different major
|
2675
|
+
# version that is higher than the major version in use and a minor
|
2676
|
+
# version (optional).
|
2677
|
+
#
|
2678
|
+
# @option params [String] :description
|
2679
|
+
# A description of the environment update.
|
2680
|
+
#
|
2681
|
+
# @option params [String] :environment_account_connection_id
|
2682
|
+
# The ID of the environment account connection.
|
2683
|
+
#
|
2684
|
+
# You can only update to a new environment account connection if it was
|
2685
|
+
# created in the same environment account that the current environment
|
2686
|
+
# account connection was created in and associated with the current
|
2687
|
+
# environment.
|
2688
|
+
#
|
2689
|
+
# @option params [required, String] :name
|
2690
|
+
# The name of the environment to update.
|
2691
|
+
#
|
2692
|
+
# @option params [String] :proton_service_role_arn
|
2693
|
+
# The ARN of the AWS Proton service role that allows AWS Proton to make
|
2694
|
+
# API calls to other services your behalf.
|
2695
|
+
#
|
2696
|
+
# @option params [String] :spec
|
2697
|
+
# The formatted specification that defines the update.
|
2698
|
+
#
|
2699
|
+
# @option params [String] :template_major_version
|
2700
|
+
# The ID of the major version of the environment to update.
|
2701
|
+
#
|
2702
|
+
# @option params [String] :template_minor_version
|
2703
|
+
# The ID of the minor version of the environment to update.
|
2704
|
+
#
|
2705
|
+
# @return [Types::UpdateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2706
|
+
#
|
2707
|
+
# * {Types::UpdateEnvironmentOutput#environment #environment} => Types::Environment
|
2708
|
+
#
|
2709
|
+
# @example Request syntax with placeholder values
|
2710
|
+
#
|
2711
|
+
# resp = client.update_environment({
|
2712
|
+
# deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
|
2713
|
+
# description: "Description",
|
2714
|
+
# environment_account_connection_id: "EnvironmentAccountConnectionId",
|
2715
|
+
# name: "ResourceName", # required
|
2716
|
+
# proton_service_role_arn: "Arn",
|
2717
|
+
# spec: "SpecContents",
|
2718
|
+
# template_major_version: "TemplateVersionPart",
|
2719
|
+
# template_minor_version: "TemplateVersionPart",
|
2720
|
+
# })
|
2721
|
+
#
|
2722
|
+
# @example Response structure
|
2723
|
+
#
|
2724
|
+
# resp.environment.arn #=> String
|
2725
|
+
# resp.environment.created_at #=> Time
|
2726
|
+
# resp.environment.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
2727
|
+
# resp.environment.deployment_status_message #=> String
|
2728
|
+
# resp.environment.description #=> String
|
2729
|
+
# resp.environment.environment_account_connection_id #=> String
|
2730
|
+
# resp.environment.environment_account_id #=> String
|
2731
|
+
# resp.environment.last_deployment_attempted_at #=> Time
|
2732
|
+
# resp.environment.last_deployment_succeeded_at #=> Time
|
2733
|
+
# resp.environment.name #=> String
|
2734
|
+
# resp.environment.proton_service_role_arn #=> String
|
2735
|
+
# resp.environment.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
2736
|
+
# resp.environment.spec #=> String
|
2737
|
+
# resp.environment.template_major_version #=> String
|
2738
|
+
# resp.environment.template_minor_version #=> String
|
2739
|
+
# resp.environment.template_name #=> String
|
2740
|
+
#
|
2741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironment AWS API Documentation
|
2742
|
+
#
|
2743
|
+
# @overload update_environment(params = {})
|
2744
|
+
# @param [Hash] params ({})
|
2745
|
+
def update_environment(params = {}, options = {})
|
2746
|
+
req = build_request(:update_environment, params)
|
2747
|
+
req.send_request(options)
|
2748
|
+
end
|
2749
|
+
|
2750
|
+
# In an environment account, update an environment account connection to
|
2751
|
+
# use a new IAM role.
|
2752
|
+
#
|
2753
|
+
# For more information, see [Environment account
|
2754
|
+
# connections](proton/latest/adminguide/ag-env-account-connections.html)
|
2755
|
+
# in the *AWS Proton Administration guide*.
|
2756
|
+
#
|
2757
|
+
# @option params [required, String] :id
|
2758
|
+
# The ID of the environment account connection to update.
|
2759
|
+
#
|
2760
|
+
# @option params [required, String] :role_arn
|
2761
|
+
# The Amazon Resource Name (ARN) of the IAM service role that is
|
2762
|
+
# associated with the environment account connection to update.
|
2763
|
+
#
|
2764
|
+
# @return [Types::UpdateEnvironmentAccountConnectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2765
|
+
#
|
2766
|
+
# * {Types::UpdateEnvironmentAccountConnectionOutput#environment_account_connection #environment_account_connection} => Types::EnvironmentAccountConnection
|
2767
|
+
#
|
2768
|
+
# @example Request syntax with placeholder values
|
2769
|
+
#
|
2770
|
+
# resp = client.update_environment_account_connection({
|
2771
|
+
# id: "EnvironmentAccountConnectionId", # required
|
2772
|
+
# role_arn: "Arn", # required
|
2773
|
+
# })
|
2774
|
+
#
|
2775
|
+
# @example Response structure
|
2776
|
+
#
|
2777
|
+
# resp.environment_account_connection.arn #=> String
|
2778
|
+
# resp.environment_account_connection.environment_account_id #=> String
|
2779
|
+
# resp.environment_account_connection.environment_name #=> String
|
2780
|
+
# resp.environment_account_connection.id #=> String
|
2781
|
+
# resp.environment_account_connection.last_modified_at #=> Time
|
2782
|
+
# resp.environment_account_connection.management_account_id #=> String
|
2783
|
+
# resp.environment_account_connection.requested_at #=> Time
|
2784
|
+
# resp.environment_account_connection.role_arn #=> String
|
2785
|
+
# resp.environment_account_connection.status #=> String, one of "PENDING", "CONNECTED", "REJECTED"
|
2786
|
+
#
|
2787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentAccountConnection AWS API Documentation
|
2788
|
+
#
|
2789
|
+
# @overload update_environment_account_connection(params = {})
|
2790
|
+
# @param [Hash] params ({})
|
2791
|
+
def update_environment_account_connection(params = {}, options = {})
|
2792
|
+
req = build_request(:update_environment_account_connection, params)
|
2793
|
+
req.send_request(options)
|
2794
|
+
end
|
2795
|
+
|
2796
|
+
# Update an environment template.
|
2797
|
+
#
|
2798
|
+
# @option params [String] :description
|
2799
|
+
# A description of the environment template update.
|
2800
|
+
#
|
2801
|
+
# @option params [String] :display_name
|
2802
|
+
# The name of the environment template to update as displayed in the
|
2803
|
+
# developer interface.
|
2804
|
+
#
|
2805
|
+
# @option params [required, String] :name
|
2806
|
+
# The name of the environment template to update.
|
2807
|
+
#
|
2808
|
+
# @return [Types::UpdateEnvironmentTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2809
|
+
#
|
2810
|
+
# * {Types::UpdateEnvironmentTemplateOutput#environment_template #environment_template} => Types::EnvironmentTemplate
|
2811
|
+
#
|
2812
|
+
# @example Request syntax with placeholder values
|
2813
|
+
#
|
2814
|
+
# resp = client.update_environment_template({
|
2815
|
+
# description: "Description",
|
2816
|
+
# display_name: "DisplayName",
|
2817
|
+
# name: "ResourceName", # required
|
2818
|
+
# })
|
2819
|
+
#
|
2820
|
+
# @example Response structure
|
2821
|
+
#
|
2822
|
+
# resp.environment_template.arn #=> String
|
2823
|
+
# resp.environment_template.created_at #=> Time
|
2824
|
+
# resp.environment_template.description #=> String
|
2825
|
+
# resp.environment_template.display_name #=> String
|
2826
|
+
# resp.environment_template.encryption_key #=> String
|
2827
|
+
# resp.environment_template.last_modified_at #=> Time
|
2828
|
+
# resp.environment_template.name #=> String
|
2829
|
+
# resp.environment_template.provisioning #=> String, one of "CUSTOMER_MANAGED"
|
2830
|
+
# resp.environment_template.recommended_version #=> String
|
2831
|
+
#
|
2832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplate AWS API Documentation
|
2833
|
+
#
|
2834
|
+
# @overload update_environment_template(params = {})
|
2835
|
+
# @param [Hash] params ({})
|
2836
|
+
def update_environment_template(params = {}, options = {})
|
2837
|
+
req = build_request(:update_environment_template, params)
|
2838
|
+
req.send_request(options)
|
2839
|
+
end
|
2840
|
+
|
2841
|
+
# Update a major or minor version of an environment template.
|
2842
|
+
#
|
2843
|
+
# @option params [String] :description
|
2844
|
+
# A description of environment template version to update.
|
2845
|
+
#
|
2846
|
+
# @option params [required, String] :major_version
|
2847
|
+
# To update a major version of an environment template, include
|
2848
|
+
# `majorVersion`.
|
2849
|
+
#
|
2850
|
+
# @option params [required, String] :minor_version
|
2851
|
+
# To update a minor version of an environment template, include
|
2852
|
+
# `minorVersion`.
|
2853
|
+
#
|
2854
|
+
# @option params [String] :status
|
2855
|
+
# The status of the environment template minor version to update.
|
2856
|
+
#
|
2857
|
+
# @option params [required, String] :template_name
|
2858
|
+
# The name of the environment template.
|
2859
|
+
#
|
2860
|
+
# @return [Types::UpdateEnvironmentTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2861
|
+
#
|
2862
|
+
# * {Types::UpdateEnvironmentTemplateVersionOutput#environment_template_version #environment_template_version} => Types::EnvironmentTemplateVersion
|
2863
|
+
#
|
2864
|
+
# @example Request syntax with placeholder values
|
2865
|
+
#
|
2866
|
+
# resp = client.update_environment_template_version({
|
2867
|
+
# description: "Description",
|
2868
|
+
# major_version: "TemplateVersionPart", # required
|
2869
|
+
# minor_version: "TemplateVersionPart", # required
|
2870
|
+
# status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
|
2871
|
+
# template_name: "ResourceName", # required
|
2872
|
+
# })
|
2873
|
+
#
|
2874
|
+
# @example Response structure
|
2875
|
+
#
|
2876
|
+
# resp.environment_template_version.arn #=> String
|
2877
|
+
# resp.environment_template_version.created_at #=> Time
|
2878
|
+
# resp.environment_template_version.description #=> String
|
2879
|
+
# resp.environment_template_version.last_modified_at #=> Time
|
2880
|
+
# resp.environment_template_version.major_version #=> String
|
2881
|
+
# resp.environment_template_version.minor_version #=> String
|
2882
|
+
# resp.environment_template_version.recommended_minor_version #=> String
|
2883
|
+
# resp.environment_template_version.schema #=> String
|
2884
|
+
# resp.environment_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
2885
|
+
# resp.environment_template_version.status_message #=> String
|
2886
|
+
# resp.environment_template_version.template_name #=> String
|
2887
|
+
#
|
2888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateEnvironmentTemplateVersion AWS API Documentation
|
2889
|
+
#
|
2890
|
+
# @overload update_environment_template_version(params = {})
|
2891
|
+
# @param [Hash] params ({})
|
2892
|
+
def update_environment_template_version(params = {}, options = {})
|
2893
|
+
req = build_request(:update_environment_template_version, params)
|
2894
|
+
req.send_request(options)
|
2895
|
+
end
|
2896
|
+
|
2897
|
+
# Edit a service description or use a spec to add and delete service
|
2898
|
+
# instances.
|
2899
|
+
#
|
2900
|
+
# <note markdown="1"> Existing service instances and the service pipeline *can't* be edited
|
2901
|
+
# using this API. They can only be deleted.
|
2902
|
+
#
|
2903
|
+
# </note>
|
2904
|
+
#
|
2905
|
+
# Use the `description` parameter to modify the description.
|
2906
|
+
#
|
2907
|
+
# Edit the `spec` parameter to add or delete instances.
|
2908
|
+
#
|
2909
|
+
# @option params [String] :description
|
2910
|
+
# The edited service description.
|
2911
|
+
#
|
2912
|
+
# @option params [required, String] :name
|
2913
|
+
# The name of the service to edit.
|
2914
|
+
#
|
2915
|
+
# @option params [String] :spec
|
2916
|
+
# Lists the service instances to add and the existing service instances
|
2917
|
+
# to remain. Omit the existing service instances to delete from the
|
2918
|
+
# list. *Don't* include edits to the existing service instances or
|
2919
|
+
# pipeline. For more information, see *Edit a service* in the [AWS
|
2920
|
+
# Proton Administration Guide][1] or the [AWS Proton User Guide][2].
|
2921
|
+
#
|
2922
|
+
#
|
2923
|
+
#
|
2924
|
+
# [1]: https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html
|
2925
|
+
# [2]: https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html
|
2926
|
+
#
|
2927
|
+
# @return [Types::UpdateServiceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2928
|
+
#
|
2929
|
+
# * {Types::UpdateServiceOutput#service #service} => Types::Service
|
2930
|
+
#
|
2931
|
+
# @example Request syntax with placeholder values
|
2932
|
+
#
|
2933
|
+
# resp = client.update_service({
|
2934
|
+
# description: "Description",
|
2935
|
+
# name: "ResourceName", # required
|
2936
|
+
# spec: "SpecContents",
|
2937
|
+
# })
|
2938
|
+
#
|
2939
|
+
# @example Response structure
|
2940
|
+
#
|
2941
|
+
# resp.service.arn #=> String
|
2942
|
+
# resp.service.branch_name #=> String
|
2943
|
+
# resp.service.created_at #=> Time
|
2944
|
+
# resp.service.description #=> String
|
2945
|
+
# resp.service.last_modified_at #=> Time
|
2946
|
+
# resp.service.name #=> String
|
2947
|
+
# resp.service.pipeline.arn #=> String
|
2948
|
+
# resp.service.pipeline.created_at #=> Time
|
2949
|
+
# resp.service.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
2950
|
+
# resp.service.pipeline.deployment_status_message #=> String
|
2951
|
+
# resp.service.pipeline.last_deployment_attempted_at #=> Time
|
2952
|
+
# resp.service.pipeline.last_deployment_succeeded_at #=> Time
|
2953
|
+
# resp.service.pipeline.spec #=> String
|
2954
|
+
# resp.service.pipeline.template_major_version #=> String
|
2955
|
+
# resp.service.pipeline.template_minor_version #=> String
|
2956
|
+
# resp.service.pipeline.template_name #=> String
|
2957
|
+
# resp.service.repository_connection_arn #=> String
|
2958
|
+
# resp.service.repository_id #=> String
|
2959
|
+
# resp.service.spec #=> String
|
2960
|
+
# resp.service.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED_CLEANUP_IN_PROGRESS", "CREATE_FAILED_CLEANUP_COMPLETE", "CREATE_FAILED_CLEANUP_FAILED", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_IN_PROGRESS", "UPDATE_FAILED_CLEANUP_COMPLETE", "UPDATE_FAILED_CLEANUP_FAILED", "UPDATE_FAILED", "UPDATE_COMPLETE_CLEANUP_FAILED"
|
2961
|
+
# resp.service.status_message #=> String
|
2962
|
+
# resp.service.template_name #=> String
|
2963
|
+
#
|
2964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateService AWS API Documentation
|
2965
|
+
#
|
2966
|
+
# @overload update_service(params = {})
|
2967
|
+
# @param [Hash] params ({})
|
2968
|
+
def update_service(params = {}, options = {})
|
2969
|
+
req = build_request(:update_service, params)
|
2970
|
+
req.send_request(options)
|
2971
|
+
end
|
2972
|
+
|
2973
|
+
# Update a service instance.
|
2974
|
+
#
|
2975
|
+
# There are four modes for updating a service instance as described in
|
2976
|
+
# the following. The `deploymentType` field defines the mode.
|
2977
|
+
#
|
2978
|
+
#
|
2979
|
+
#
|
2980
|
+
# : `NONE`
|
2981
|
+
#
|
2982
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
2983
|
+
# metadata parameters are updated.
|
2984
|
+
#
|
2985
|
+
#
|
2986
|
+
#
|
2987
|
+
# : `CURRENT_VERSION`
|
2988
|
+
#
|
2989
|
+
# In this mode, the service instance is deployed and updated with the
|
2990
|
+
# new spec that you provide. Only requested parameters are updated.
|
2991
|
+
# *Don’t* include minor or major version parameters when you use this
|
2992
|
+
# `deployment-type`.
|
2993
|
+
#
|
2994
|
+
#
|
2995
|
+
#
|
2996
|
+
# : `MINOR_VERSION`
|
2997
|
+
#
|
2998
|
+
# In this mode, the service instance is deployed and updated with the
|
2999
|
+
# published, recommended (latest) minor version of the current major
|
3000
|
+
# version in use, by default. You can also specify a different minor
|
3001
|
+
# version of the current major version in use.
|
3002
|
+
#
|
3003
|
+
#
|
3004
|
+
#
|
3005
|
+
# : `MAJOR_VERSION`
|
3006
|
+
#
|
3007
|
+
# In this mode, the service instance is deployed and updated with the
|
3008
|
+
# published, recommended (latest) major and minor version of the
|
3009
|
+
# current template, by default. You can also specify a different major
|
3010
|
+
# version that is higher than the major version in use and a minor
|
3011
|
+
# version (optional).
|
3012
|
+
#
|
3013
|
+
# @option params [required, String] :deployment_type
|
3014
|
+
# The deployment type.
|
3015
|
+
#
|
3016
|
+
# There are four modes for updating a service instance as described in
|
3017
|
+
# the following. The `deploymentType` field defines the mode.
|
3018
|
+
#
|
3019
|
+
#
|
3020
|
+
#
|
3021
|
+
# : `NONE`
|
3022
|
+
#
|
3023
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
3024
|
+
# metadata parameters are updated.
|
3025
|
+
#
|
3026
|
+
#
|
3027
|
+
#
|
3028
|
+
# : `CURRENT_VERSION`
|
3029
|
+
#
|
3030
|
+
# In this mode, the service instance is deployed and updated with the
|
3031
|
+
# new spec that you provide. Only requested parameters are updated.
|
3032
|
+
# *Don’t* include minor or major version parameters when you use this
|
3033
|
+
# `deployment-type`.
|
3034
|
+
#
|
3035
|
+
#
|
3036
|
+
#
|
3037
|
+
# : `MINOR_VERSION`
|
3038
|
+
#
|
3039
|
+
# In this mode, the service instance is deployed and updated with the
|
3040
|
+
# published, recommended (latest) minor version of the current major
|
3041
|
+
# version in use, by default. You can also specify a different minor
|
3042
|
+
# version of the current major version in use.
|
3043
|
+
#
|
3044
|
+
#
|
3045
|
+
#
|
3046
|
+
# : `MAJOR_VERSION`
|
3047
|
+
#
|
3048
|
+
# In this mode, the service instance is deployed and updated with the
|
3049
|
+
# published, recommended (latest) major and minor version of the
|
3050
|
+
# current template, by default. You can also specify a different major
|
3051
|
+
# version that is higher than the major version in use and a minor
|
3052
|
+
# version (optional).
|
3053
|
+
#
|
3054
|
+
# @option params [required, String] :name
|
3055
|
+
# The name of the service instance to update.
|
3056
|
+
#
|
3057
|
+
# @option params [required, String] :service_name
|
3058
|
+
# The name of the service that the service instance belongs to.
|
3059
|
+
#
|
3060
|
+
# @option params [String] :spec
|
3061
|
+
# The formatted specification that defines the service instance update.
|
3062
|
+
#
|
3063
|
+
# @option params [String] :template_major_version
|
3064
|
+
# The major version of the service template to update.
|
3065
|
+
#
|
3066
|
+
# @option params [String] :template_minor_version
|
3067
|
+
# The minor version of the service template to update.
|
3068
|
+
#
|
3069
|
+
# @return [Types::UpdateServiceInstanceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3070
|
+
#
|
3071
|
+
# * {Types::UpdateServiceInstanceOutput#service_instance #service_instance} => Types::ServiceInstance
|
3072
|
+
#
|
3073
|
+
# @example Request syntax with placeholder values
|
3074
|
+
#
|
3075
|
+
# resp = client.update_service_instance({
|
3076
|
+
# deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
|
3077
|
+
# name: "ResourceName", # required
|
3078
|
+
# service_name: "ResourceName", # required
|
3079
|
+
# spec: "SpecContents",
|
3080
|
+
# template_major_version: "TemplateVersionPart",
|
3081
|
+
# template_minor_version: "TemplateVersionPart",
|
3082
|
+
# })
|
3083
|
+
#
|
3084
|
+
# @example Response structure
|
3085
|
+
#
|
3086
|
+
# resp.service_instance.arn #=> String
|
3087
|
+
# resp.service_instance.created_at #=> Time
|
3088
|
+
# resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
3089
|
+
# resp.service_instance.deployment_status_message #=> String
|
3090
|
+
# resp.service_instance.environment_name #=> String
|
3091
|
+
# resp.service_instance.last_deployment_attempted_at #=> Time
|
3092
|
+
# resp.service_instance.last_deployment_succeeded_at #=> Time
|
3093
|
+
# resp.service_instance.name #=> String
|
3094
|
+
# resp.service_instance.service_name #=> String
|
3095
|
+
# resp.service_instance.spec #=> String
|
3096
|
+
# resp.service_instance.template_major_version #=> String
|
3097
|
+
# resp.service_instance.template_minor_version #=> String
|
3098
|
+
# resp.service_instance.template_name #=> String
|
3099
|
+
#
|
3100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceInstance AWS API Documentation
|
3101
|
+
#
|
3102
|
+
# @overload update_service_instance(params = {})
|
3103
|
+
# @param [Hash] params ({})
|
3104
|
+
def update_service_instance(params = {}, options = {})
|
3105
|
+
req = build_request(:update_service_instance, params)
|
3106
|
+
req.send_request(options)
|
3107
|
+
end
|
3108
|
+
|
3109
|
+
# Update the service pipeline.
|
3110
|
+
#
|
3111
|
+
# There are four modes for updating a service pipeline as described in
|
3112
|
+
# the following. The `deploymentType` field defines the mode.
|
3113
|
+
#
|
3114
|
+
#
|
3115
|
+
#
|
3116
|
+
# : `NONE`
|
3117
|
+
#
|
3118
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
3119
|
+
# metadata parameters are updated.
|
3120
|
+
#
|
3121
|
+
#
|
3122
|
+
#
|
3123
|
+
# : `CURRENT_VERSION`
|
3124
|
+
#
|
3125
|
+
# In this mode, the service pipeline is deployed and updated with the
|
3126
|
+
# new spec that you provide. Only requested parameters are updated.
|
3127
|
+
# *Don’t* include minor or major version parameters when you use this
|
3128
|
+
# `deployment-type`.
|
3129
|
+
#
|
3130
|
+
#
|
3131
|
+
#
|
3132
|
+
# : `MINOR_VERSION`
|
3133
|
+
#
|
3134
|
+
# In this mode, the service pipeline is deployed and updated with the
|
3135
|
+
# published, recommended (latest) minor version of the current major
|
3136
|
+
# version in use, by default. You can also specify a different minor
|
3137
|
+
# version of the current major version in use.
|
3138
|
+
#
|
3139
|
+
#
|
3140
|
+
#
|
3141
|
+
# : `MAJOR_VERSION`
|
3142
|
+
#
|
3143
|
+
# In this mode, the service pipeline is deployed and updated with the
|
3144
|
+
# published, recommended (latest) major and minor version of the
|
3145
|
+
# current template by default. You can also specify a different major
|
3146
|
+
# version that is higher than the major version in use and a minor
|
3147
|
+
# version (optional).
|
3148
|
+
#
|
3149
|
+
# @option params [required, String] :deployment_type
|
3150
|
+
# The deployment type.
|
3151
|
+
#
|
3152
|
+
# There are four modes for updating a service pipeline as described in
|
3153
|
+
# the following. The `deploymentType` field defines the mode.
|
3154
|
+
#
|
3155
|
+
#
|
3156
|
+
#
|
3157
|
+
# : `NONE`
|
3158
|
+
#
|
3159
|
+
# In this mode, a deployment *doesn't* occur. Only the requested
|
3160
|
+
# metadata parameters are updated.
|
3161
|
+
#
|
3162
|
+
#
|
3163
|
+
#
|
3164
|
+
# : `CURRENT_VERSION`
|
3165
|
+
#
|
3166
|
+
# In this mode, the service pipeline is deployed and updated with the
|
3167
|
+
# new spec that you provide. Only requested parameters are updated.
|
3168
|
+
# *Don’t* include minor or major version parameters when you use this
|
3169
|
+
# `deployment-type`.
|
3170
|
+
#
|
3171
|
+
#
|
3172
|
+
#
|
3173
|
+
# : `MINOR_VERSION`
|
3174
|
+
#
|
3175
|
+
# In this mode, the service pipeline is deployed and updated with the
|
3176
|
+
# published, recommended (latest) minor version of the current major
|
3177
|
+
# version in use, by default. You can also specify a different minor
|
3178
|
+
# version of the current major version in use.
|
3179
|
+
#
|
3180
|
+
#
|
3181
|
+
#
|
3182
|
+
# : `MAJOR_VERSION`
|
3183
|
+
#
|
3184
|
+
# In this mode, the service pipeline is deployed and updated with the
|
3185
|
+
# published, recommended (latest) major and minor version of the
|
3186
|
+
# current template, by default. You can also specify a different major
|
3187
|
+
# version that is higher than the major version in use and a minor
|
3188
|
+
# version (optional).
|
3189
|
+
#
|
3190
|
+
# @option params [required, String] :service_name
|
3191
|
+
# The name of the service to that the pipeline is associated with.
|
3192
|
+
#
|
3193
|
+
# @option params [required, String] :spec
|
3194
|
+
# The spec for the service pipeline to update.
|
3195
|
+
#
|
3196
|
+
# @option params [String] :template_major_version
|
3197
|
+
# The major version of the service template that was used to create the
|
3198
|
+
# service that the pipeline is associated with.
|
3199
|
+
#
|
3200
|
+
# @option params [String] :template_minor_version
|
3201
|
+
# The minor version of the service template that was used to create the
|
3202
|
+
# service that the pipeline is associated with.
|
3203
|
+
#
|
3204
|
+
# @return [Types::UpdateServicePipelineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3205
|
+
#
|
3206
|
+
# * {Types::UpdateServicePipelineOutput#pipeline #pipeline} => Types::ServicePipeline
|
3207
|
+
#
|
3208
|
+
# @example Request syntax with placeholder values
|
3209
|
+
#
|
3210
|
+
# resp = client.update_service_pipeline({
|
3211
|
+
# deployment_type: "NONE", # required, accepts NONE, CURRENT_VERSION, MINOR_VERSION, MAJOR_VERSION
|
3212
|
+
# service_name: "ResourceName", # required
|
3213
|
+
# spec: "SpecContents", # required
|
3214
|
+
# template_major_version: "TemplateVersionPart",
|
3215
|
+
# template_minor_version: "TemplateVersionPart",
|
3216
|
+
# })
|
3217
|
+
#
|
3218
|
+
# @example Response structure
|
3219
|
+
#
|
3220
|
+
# resp.pipeline.arn #=> String
|
3221
|
+
# resp.pipeline.created_at #=> Time
|
3222
|
+
# resp.pipeline.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
|
3223
|
+
# resp.pipeline.deployment_status_message #=> String
|
3224
|
+
# resp.pipeline.last_deployment_attempted_at #=> Time
|
3225
|
+
# resp.pipeline.last_deployment_succeeded_at #=> Time
|
3226
|
+
# resp.pipeline.spec #=> String
|
3227
|
+
# resp.pipeline.template_major_version #=> String
|
3228
|
+
# resp.pipeline.template_minor_version #=> String
|
3229
|
+
# resp.pipeline.template_name #=> String
|
3230
|
+
#
|
3231
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServicePipeline AWS API Documentation
|
3232
|
+
#
|
3233
|
+
# @overload update_service_pipeline(params = {})
|
3234
|
+
# @param [Hash] params ({})
|
3235
|
+
def update_service_pipeline(params = {}, options = {})
|
3236
|
+
req = build_request(:update_service_pipeline, params)
|
3237
|
+
req.send_request(options)
|
3238
|
+
end
|
3239
|
+
|
3240
|
+
# Update a service template.
|
3241
|
+
#
|
3242
|
+
# @option params [String] :description
|
3243
|
+
# A description of the service template update.
|
3244
|
+
#
|
3245
|
+
# @option params [String] :display_name
|
3246
|
+
# The name of the service template to update as displayed in the
|
3247
|
+
# developer interface.
|
3248
|
+
#
|
3249
|
+
# @option params [required, String] :name
|
3250
|
+
# The name of the service template to update.
|
3251
|
+
#
|
3252
|
+
# @return [Types::UpdateServiceTemplateOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3253
|
+
#
|
3254
|
+
# * {Types::UpdateServiceTemplateOutput#service_template #service_template} => Types::ServiceTemplate
|
3255
|
+
#
|
3256
|
+
# @example Request syntax with placeholder values
|
3257
|
+
#
|
3258
|
+
# resp = client.update_service_template({
|
3259
|
+
# description: "Description",
|
3260
|
+
# display_name: "DisplayName",
|
3261
|
+
# name: "ResourceName", # required
|
3262
|
+
# })
|
3263
|
+
#
|
3264
|
+
# @example Response structure
|
3265
|
+
#
|
3266
|
+
# resp.service_template.arn #=> String
|
3267
|
+
# resp.service_template.created_at #=> Time
|
3268
|
+
# resp.service_template.description #=> String
|
3269
|
+
# resp.service_template.display_name #=> String
|
3270
|
+
# resp.service_template.encryption_key #=> String
|
3271
|
+
# resp.service_template.last_modified_at #=> Time
|
3272
|
+
# resp.service_template.name #=> String
|
3273
|
+
# resp.service_template.pipeline_provisioning #=> String, one of "CUSTOMER_MANAGED"
|
3274
|
+
# resp.service_template.recommended_version #=> String
|
3275
|
+
#
|
3276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplate AWS API Documentation
|
3277
|
+
#
|
3278
|
+
# @overload update_service_template(params = {})
|
3279
|
+
# @param [Hash] params ({})
|
3280
|
+
def update_service_template(params = {}, options = {})
|
3281
|
+
req = build_request(:update_service_template, params)
|
3282
|
+
req.send_request(options)
|
3283
|
+
end
|
3284
|
+
|
3285
|
+
# Update a major or minor version of a service template.
|
3286
|
+
#
|
3287
|
+
# @option params [Array<Types::CompatibleEnvironmentTemplateInput>] :compatible_environment_templates
|
3288
|
+
# An array of compatible environment names for a service template major
|
3289
|
+
# or minor version to update.
|
3290
|
+
#
|
3291
|
+
# @option params [String] :description
|
3292
|
+
# A description of a service template version to update.
|
3293
|
+
#
|
3294
|
+
# @option params [required, String] :major_version
|
3295
|
+
# To update a major version of a service template, include
|
3296
|
+
# `majorVersion`.
|
3297
|
+
#
|
3298
|
+
# @option params [required, String] :minor_version
|
3299
|
+
# To update a minor version of a service template, include
|
3300
|
+
# `minorVersion`.
|
3301
|
+
#
|
3302
|
+
# @option params [String] :status
|
3303
|
+
# The status of the service template minor version to update.
|
3304
|
+
#
|
3305
|
+
# @option params [required, String] :template_name
|
3306
|
+
# The name of the service template.
|
3307
|
+
#
|
3308
|
+
# @return [Types::UpdateServiceTemplateVersionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3309
|
+
#
|
3310
|
+
# * {Types::UpdateServiceTemplateVersionOutput#service_template_version #service_template_version} => Types::ServiceTemplateVersion
|
3311
|
+
#
|
3312
|
+
# @example Request syntax with placeholder values
|
3313
|
+
#
|
3314
|
+
# resp = client.update_service_template_version({
|
3315
|
+
# compatible_environment_templates: [
|
3316
|
+
# {
|
3317
|
+
# major_version: "TemplateVersionPart", # required
|
3318
|
+
# template_name: "ResourceName", # required
|
3319
|
+
# },
|
3320
|
+
# ],
|
3321
|
+
# description: "Description",
|
3322
|
+
# major_version: "TemplateVersionPart", # required
|
3323
|
+
# minor_version: "TemplateVersionPart", # required
|
3324
|
+
# status: "REGISTRATION_IN_PROGRESS", # accepts REGISTRATION_IN_PROGRESS, REGISTRATION_FAILED, DRAFT, PUBLISHED
|
3325
|
+
# template_name: "ResourceName", # required
|
3326
|
+
# })
|
3327
|
+
#
|
3328
|
+
# @example Response structure
|
3329
|
+
#
|
3330
|
+
# resp.service_template_version.arn #=> String
|
3331
|
+
# resp.service_template_version.compatible_environment_templates #=> Array
|
3332
|
+
# resp.service_template_version.compatible_environment_templates[0].major_version #=> String
|
3333
|
+
# resp.service_template_version.compatible_environment_templates[0].template_name #=> String
|
3334
|
+
# resp.service_template_version.created_at #=> Time
|
3335
|
+
# resp.service_template_version.description #=> String
|
3336
|
+
# resp.service_template_version.last_modified_at #=> Time
|
3337
|
+
# resp.service_template_version.major_version #=> String
|
3338
|
+
# resp.service_template_version.minor_version #=> String
|
3339
|
+
# resp.service_template_version.recommended_minor_version #=> String
|
3340
|
+
# resp.service_template_version.schema #=> String
|
3341
|
+
# resp.service_template_version.status #=> String, one of "REGISTRATION_IN_PROGRESS", "REGISTRATION_FAILED", "DRAFT", "PUBLISHED"
|
3342
|
+
# resp.service_template_version.status_message #=> String
|
3343
|
+
# resp.service_template_version.template_name #=> String
|
3344
|
+
#
|
3345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/UpdateServiceTemplateVersion AWS API Documentation
|
3346
|
+
#
|
3347
|
+
# @overload update_service_template_version(params = {})
|
3348
|
+
# @param [Hash] params ({})
|
3349
|
+
def update_service_template_version(params = {}, options = {})
|
3350
|
+
req = build_request(:update_service_template_version, params)
|
3351
|
+
req.send_request(options)
|
3352
|
+
end
|
3353
|
+
|
3354
|
+
# @!endgroup
|
3355
|
+
|
3356
|
+
# @param params ({})
|
3357
|
+
# @api private
|
3358
|
+
def build_request(operation_name, params = {})
|
3359
|
+
handlers = @handlers.for(operation_name)
|
3360
|
+
context = Seahorse::Client::RequestContext.new(
|
3361
|
+
operation_name: operation_name,
|
3362
|
+
operation: config.api.operation(operation_name),
|
3363
|
+
client: self,
|
3364
|
+
params: params,
|
3365
|
+
config: config)
|
3366
|
+
context[:gem_name] = 'aws-sdk-proton'
|
3367
|
+
context[:gem_version] = '1.0.0'
|
3368
|
+
Seahorse::Client::Request.new(handlers, context)
|
3369
|
+
end
|
3370
|
+
|
3371
|
+
# @api private
|
3372
|
+
# @deprecated
|
3373
|
+
def waiter_names
|
3374
|
+
[]
|
3375
|
+
end
|
3376
|
+
|
3377
|
+
class << self
|
3378
|
+
|
3379
|
+
# @api private
|
3380
|
+
attr_reader :identifier
|
3381
|
+
|
3382
|
+
# @api private
|
3383
|
+
def errors_module
|
3384
|
+
Errors
|
3385
|
+
end
|
3386
|
+
|
3387
|
+
end
|
3388
|
+
end
|
3389
|
+
end
|