@aws-sdk/client-proton 3.55.0 → 3.63.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +36 -46
- package/dist-cjs/protocols/Aws_json1_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +1 -1
- package/dist-types/Proton.d.ts +153 -162
- package/dist-types/ProtonClient.d.ts +36 -46
- package/dist-types/commands/AcceptEnvironmentAccountConnectionCommand.d.ts +3 -3
- package/dist-types/commands/CancelEnvironmentDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CancelServiceInstanceDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CancelServicePipelineDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CreateEnvironmentAccountConnectionCommand.d.ts +5 -5
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +7 -8
- package/dist-types/commands/CreateEnvironmentTemplateCommand.d.ts +5 -4
- package/dist-types/commands/CreateEnvironmentTemplateVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateRepositoryCommand.d.ts +5 -3
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -4
- package/dist-types/commands/CreateServiceTemplateCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceTemplateVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +3 -4
- package/dist-types/commands/DeleteEnvironmentAccountConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteEnvironmentTemplateVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteServiceTemplateVersionCommand.d.ts +6 -6
- package/dist-types/commands/GetEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GetRepositorySyncStatusCommand.d.ts +8 -1
- package/dist-types/commands/GetServiceInstanceCommand.d.ts +1 -2
- package/dist-types/commands/ListEnvironmentAccountConnectionsCommand.d.ts +1 -1
- package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +2 -7
- package/dist-types/commands/RejectEnvironmentAccountConnectionCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +19 -18
- package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +5 -7
- package/dist-types/commands/UpdateServicePipelineCommand.d.ts +5 -7
- package/dist-types/models/models_0.d.ts +180 -227
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +18 -18
package/dist-types/Proton.d.ts
CHANGED
|
@@ -68,55 +68,48 @@ import { UpdateServiceTemplateVersionCommandInput, UpdateServiceTemplateVersionC
|
|
|
68
68
|
import { UpdateTemplateSyncConfigCommandInput, UpdateTemplateSyncConfigCommandOutput } from "./commands/UpdateTemplateSyncConfigCommand";
|
|
69
69
|
import { ProtonClient } from "./ProtonClient";
|
|
70
70
|
/**
|
|
71
|
-
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
72
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html">actions</a> and <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html">data types</a> for the Proton
|
|
73
|
-
* service.</p>
|
|
71
|
+
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html">actions</a> and <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html">data types</a> for the Proton service.</p>
|
|
74
72
|
* <p>The documentation for each action shows the Query API request parameters and the XML response.</p>
|
|
75
|
-
* <p>Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">Amazon Web Services Command Line Interface User
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
* <i>
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* <p>To learn more about Proton administration, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html">Proton Administrator Guide</a>.</p>
|
|
73
|
+
* <p>Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">Amazon Web Services Command Line Interface User Guide</a>.</p>
|
|
74
|
+
* <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure
|
|
75
|
+
* and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to
|
|
76
|
+
* automate their application or service deployments.</p>
|
|
77
|
+
* <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the
|
|
78
|
+
* listed API operations.</p>
|
|
79
|
+
* <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are
|
|
80
|
+
* running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>,
|
|
81
|
+
* <i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and
|
|
82
|
+
* <i>update</i> API operations.</p>
|
|
83
|
+
* <p>To learn more about Proton administration, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html">Proton
|
|
84
|
+
* Administrator Guide</a>.</p>
|
|
88
85
|
* <p>To learn more about deploying serverless and containerized applications on Proton, see the <a href="https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html">Proton User Guide</a>.</p>
|
|
89
86
|
* <p>
|
|
90
87
|
* <b>Ensuring Idempotency</b>
|
|
91
88
|
* </p>
|
|
92
|
-
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
93
|
-
*
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
* occurs multiple times. This means that you might create more resources than you intended.</p>
|
|
89
|
+
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete.
|
|
90
|
+
* Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might
|
|
91
|
+
* make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the
|
|
92
|
+
* operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times.
|
|
93
|
+
* This means that you might create more resources than you intended.</p>
|
|
98
94
|
* <p>
|
|
99
|
-
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
* the current creation status.</p>
|
|
95
|
+
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an idempotent request, if the
|
|
96
|
+
* original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the
|
|
97
|
+
* result might contain updated information, such as the current creation status.</p>
|
|
103
98
|
* <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
|
|
104
99
|
* <p>
|
|
105
100
|
* <b>Idempotent create APIs with a client token</b>
|
|
106
101
|
* </p>
|
|
107
|
-
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
* provided by SDKs.</p>
|
|
102
|
+
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The corresponding Amazon Web Services CLI commands
|
|
103
|
+
* also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an
|
|
104
|
+
* idempotent API request using one of these actions, specify a client token in the request. We recommend that you <i>don't</i> reuse
|
|
105
|
+
* the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided
|
|
106
|
+
* by SDKs.</p>
|
|
113
107
|
* <p>Given a request action that has succeeded:</p>
|
|
114
|
-
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
115
|
-
*
|
|
116
|
-
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
117
|
-
*
|
|
118
|
-
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
119
|
-
* resource is created.</p>
|
|
108
|
+
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other
|
|
109
|
+
* than returning the original resource detail data in the response.</p>
|
|
110
|
+
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a
|
|
111
|
+
* <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
|
|
112
|
+
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.</p>
|
|
120
113
|
* <p>If the original resource is deleted and you retry the request, a new resource is created.</p>
|
|
121
114
|
* <p>Idempotent create APIs with a client token:</p>
|
|
122
115
|
* <ul>
|
|
@@ -134,9 +127,8 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
134
127
|
* <b>Idempotent create APIs</b>
|
|
135
128
|
* </p>
|
|
136
129
|
* <p>Given a request action that has succeeded:</p>
|
|
137
|
-
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
138
|
-
*
|
|
139
|
-
* data in the response.</p>
|
|
130
|
+
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been modified, the retry succeeds
|
|
131
|
+
* without performing any further actions other than returning the original resource detail data in the response.</p>
|
|
140
132
|
* <p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
|
|
141
133
|
* <p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
|
|
142
134
|
* <code>IdempotentParameterMismatch</code> error.</p>
|
|
@@ -159,8 +151,7 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
159
151
|
* <b>Idempotent delete APIs</b>
|
|
160
152
|
* </p>
|
|
161
153
|
* <p>Given a request action that has succeeded:</p>
|
|
162
|
-
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
163
|
-
* the response.</p>
|
|
154
|
+
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.</p>
|
|
164
155
|
* <p>If you retry and the resource doesn't exist, the response is empty.</p>
|
|
165
156
|
* <p>In both cases, the retry succeeds.</p>
|
|
166
157
|
* <p>Idempotent delete APIs:</p>
|
|
@@ -185,9 +176,8 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
185
176
|
* <b>Asynchronous idempotent delete APIs</b>
|
|
186
177
|
* </p>
|
|
187
178
|
* <p>Given a request action that has succeeded:</p>
|
|
188
|
-
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
189
|
-
*
|
|
190
|
-
* further actions.</p>
|
|
179
|
+
* <p>If you retry the request with an API from this group, if the original request delete operation status is <code>DELETE_IN_PROGRESS</code>, the
|
|
180
|
+
* retry returns the resource detail data in the response without performing any further actions.</p>
|
|
191
181
|
* <p>If the original request delete operation is complete, a retry returns an empty response.</p>
|
|
192
182
|
* <p>Asynchronous idempotent delete APIs:</p>
|
|
193
183
|
* <ul>
|
|
@@ -201,18 +191,18 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
201
191
|
*/
|
|
202
192
|
export declare class Proton extends ProtonClient {
|
|
203
193
|
/**
|
|
204
|
-
* <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted,
|
|
205
|
-
*
|
|
194
|
+
* <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton
|
|
195
|
+
* can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p>
|
|
206
196
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
207
|
-
*
|
|
197
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
208
198
|
*/
|
|
209
199
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<AcceptEnvironmentAccountConnectionCommandOutput>;
|
|
210
200
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
211
201
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
212
202
|
/**
|
|
213
|
-
* <p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
214
|
-
*
|
|
215
|
-
*
|
|
203
|
+
* <p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more
|
|
204
|
+
* information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-update.html">Update an environment</a> in the <i>Proton
|
|
205
|
+
* Administrator guide</i>.</p>
|
|
216
206
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
217
207
|
* <ul>
|
|
218
208
|
* <li>
|
|
@@ -223,7 +213,7 @@ export declare class Proton extends ProtonClient {
|
|
|
223
213
|
* </li>
|
|
224
214
|
* <li>
|
|
225
215
|
* <p>If the current <a>UpdateEnvironment</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
|
|
226
|
-
*
|
|
216
|
+
* <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
|
|
227
217
|
* </li>
|
|
228
218
|
* </ul>
|
|
229
219
|
*/
|
|
@@ -231,8 +221,8 @@ export declare class Proton extends ProtonClient {
|
|
|
231
221
|
cancelEnvironmentDeployment(args: CancelEnvironmentDeploymentCommandInput, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void): void;
|
|
232
222
|
cancelEnvironmentDeployment(args: CancelEnvironmentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void): void;
|
|
233
223
|
/**
|
|
234
|
-
* <p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is
|
|
235
|
-
*
|
|
224
|
+
* <p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
225
|
+
* For more information, see <i>Update a service instance</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html">Proton Administrator guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html">Proton User guide</a>.</p>
|
|
236
226
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
237
227
|
* <ul>
|
|
238
228
|
* <li>
|
|
@@ -242,8 +232,8 @@ export declare class Proton extends ProtonClient {
|
|
|
242
232
|
* <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p>
|
|
243
233
|
* </li>
|
|
244
234
|
* <li>
|
|
245
|
-
* <p>If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment
|
|
246
|
-
*
|
|
235
|
+
* <p>If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
|
|
236
|
+
* <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
|
|
247
237
|
* </li>
|
|
248
238
|
* </ul>
|
|
249
239
|
*/
|
|
@@ -251,8 +241,8 @@ export declare class Proton extends ProtonClient {
|
|
|
251
241
|
cancelServiceInstanceDeployment(args: CancelServiceInstanceDeploymentCommandInput, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void): void;
|
|
252
242
|
cancelServiceInstanceDeployment(args: CancelServiceInstanceDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void): void;
|
|
253
243
|
/**
|
|
254
|
-
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is
|
|
255
|
-
*
|
|
244
|
+
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
245
|
+
* For more information, see <i>Update a service pipeline</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html">Proton Administrator guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html">Proton User guide</a>.</p>
|
|
256
246
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
257
247
|
* <ul>
|
|
258
248
|
* <li>
|
|
@@ -262,8 +252,8 @@ export declare class Proton extends ProtonClient {
|
|
|
262
252
|
* <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p>
|
|
263
253
|
* </li>
|
|
264
254
|
* <li>
|
|
265
|
-
* <p>If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment
|
|
266
|
-
*
|
|
255
|
+
* <p>If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
|
|
256
|
+
* <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
|
|
267
257
|
* </li>
|
|
268
258
|
* </ul>
|
|
269
259
|
*/
|
|
@@ -271,33 +261,32 @@ export declare class Proton extends ProtonClient {
|
|
|
271
261
|
cancelServicePipelineDeployment(args: CancelServicePipelineDeploymentCommandInput, cb: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void): void;
|
|
272
262
|
cancelServicePipelineDeployment(args: CancelServicePipelineDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void): void;
|
|
273
263
|
/**
|
|
274
|
-
* <p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can
|
|
275
|
-
*
|
|
264
|
+
* <p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be
|
|
265
|
+
* shared across services.</p>
|
|
276
266
|
* <p class="title">
|
|
277
267
|
* <b>You can provision environments using the following methods:</b>
|
|
278
268
|
* </p>
|
|
279
269
|
* <ul>
|
|
280
270
|
* <li>
|
|
281
|
-
* <p>
|
|
271
|
+
* <p>Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.</p>
|
|
282
272
|
* </li>
|
|
283
273
|
* <li>
|
|
284
|
-
* <p>
|
|
285
|
-
*
|
|
274
|
+
* <p>Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC
|
|
275
|
+
* engine uses to provision resources.</p>
|
|
286
276
|
* </li>
|
|
287
277
|
* </ul>
|
|
288
|
-
* <p>For more information, see
|
|
289
|
-
*
|
|
290
|
-
* </p>
|
|
278
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton Administrator
|
|
279
|
+
* Guide</i>.</p>
|
|
291
280
|
*/
|
|
292
281
|
createEnvironment(args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentCommandOutput>;
|
|
293
282
|
createEnvironment(args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
|
|
294
283
|
createEnvironment(args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
|
|
295
284
|
/**
|
|
296
|
-
* <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the
|
|
297
|
-
*
|
|
298
|
-
* <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an
|
|
299
|
-
*
|
|
300
|
-
*
|
|
285
|
+
* <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment
|
|
286
|
+
* account from a management account.</p>
|
|
287
|
+
* <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an <i>environment
|
|
288
|
+
* account</i> that maintains authorization and permissions. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton Administrator
|
|
289
|
+
* guide</i>.</p>
|
|
301
290
|
*/
|
|
302
291
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentAccountConnectionCommandOutput>;
|
|
303
292
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -308,13 +297,14 @@ export declare class Proton extends ProtonClient {
|
|
|
308
297
|
* <ul>
|
|
309
298
|
* <li>
|
|
310
299
|
* <p>Register and publish a <i>standard</i> environment template that instructs Proton to deploy and manage environment
|
|
311
|
-
*
|
|
300
|
+
* infrastructure.</p>
|
|
312
301
|
* </li>
|
|
313
302
|
* <li>
|
|
314
303
|
* <p>Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned
|
|
315
|
-
*
|
|
316
|
-
*
|
|
317
|
-
*
|
|
304
|
+
* infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment
|
|
305
|
+
* template for customer provisioned and managed infrastructure, include the <code>provisioning</code> parameter and set the value to
|
|
306
|
+
* <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/template-create.html">Register
|
|
307
|
+
* and publish an environment template</a> in the <i>Proton Administrator Guide</i>.</p>
|
|
318
308
|
* </li>
|
|
319
309
|
* </ul>
|
|
320
310
|
*/
|
|
@@ -323,51 +313,52 @@ export declare class Proton extends ProtonClient {
|
|
|
323
313
|
createEnvironmentTemplate(args: CreateEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateCommandOutput) => void): void;
|
|
324
314
|
/**
|
|
325
315
|
* <p>Create a new major or minor version of an environment template. A major version of an environment template is a version that
|
|
326
|
-
*
|
|
327
|
-
*
|
|
316
|
+
* <i>isn't</i> backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major
|
|
317
|
+
* version.</p>
|
|
328
318
|
*/
|
|
329
319
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentTemplateVersionCommandOutput>;
|
|
330
320
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
331
321
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
332
322
|
/**
|
|
333
|
-
* <p>Create and register a link to a repository that can be used with
|
|
334
|
-
*
|
|
335
|
-
*
|
|
323
|
+
* <p>Create and register a link to a repository that can be used with self-managed provisioning (infrastructure or pipelines) or for template sync
|
|
324
|
+
* configurations. When you create a repository link, Proton creates a <a href="https://docs.aws.amazon.com/proton/latest/adminguide/using-service-linked-roles.html">service-linked role</a> for you.</p>
|
|
325
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a>, <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html">Template bundles</a>, and
|
|
326
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
|
|
327
|
+
* Administrator Guide</i>.</p>
|
|
336
328
|
*/
|
|
337
329
|
createRepository(args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<CreateRepositoryCommandOutput>;
|
|
338
330
|
createRepository(args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
|
|
339
331
|
createRepository(args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
|
|
340
332
|
/**
|
|
341
|
-
* <p>Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
333
|
+
* <p>Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline.
|
|
334
|
+
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html">Services</a> in the <i>Proton
|
|
335
|
+
* Administrator Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html">Services</a> in the <i>Proton
|
|
336
|
+
* User Guide</i>.</p>
|
|
345
337
|
*/
|
|
346
338
|
createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceCommandOutput>;
|
|
347
339
|
createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
348
340
|
createService(args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
349
341
|
/**
|
|
350
|
-
* <p>Create a service template. The administrator creates a service template to define standardized infrastructure and an optional
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
354
|
-
*
|
|
342
|
+
* <p>Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline.
|
|
343
|
+
* Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a
|
|
344
|
+
* link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more
|
|
345
|
+
* information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html">Service Templates</a> in the
|
|
346
|
+
* <i>Proton Administrator Guide</i>.</p>
|
|
355
347
|
*/
|
|
356
348
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceTemplateCommandOutput>;
|
|
357
349
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void): void;
|
|
358
350
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void): void;
|
|
359
351
|
/**
|
|
360
|
-
* <p>Create a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i>
|
|
361
|
-
*
|
|
352
|
+
* <p>Create a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i> backward
|
|
353
|
+
* compatible. A minor version of a service template is a version that's backward compatible within its major version.</p>
|
|
362
354
|
*/
|
|
363
355
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceTemplateVersionCommandOutput>;
|
|
364
356
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
365
357
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
366
358
|
/**
|
|
367
|
-
* <p>Set up a template
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
* the <i>Proton Administrator Guide</i>.</p>
|
|
359
|
+
* <p>Set up a template to create new template versions automatically. When a commit is pushed to your registered <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Repository.html">repository</a>, Proton checks for changes to your repository template bundles. If it detects
|
|
360
|
+
* a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
|
|
361
|
+
* Administrator Guide</i>.</p>
|
|
371
362
|
*/
|
|
372
363
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateSyncConfigCommandOutput>;
|
|
373
364
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void): void;
|
|
@@ -381,10 +372,10 @@ export declare class Proton extends ProtonClient {
|
|
|
381
372
|
/**
|
|
382
373
|
* <p>In an environment account, delete an environment account connection.</p>
|
|
383
374
|
* <p>After you delete an environment account connection that’s in use by an Proton environment, Proton <i>can’t</i> manage the
|
|
384
|
-
*
|
|
385
|
-
*
|
|
375
|
+
* environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're
|
|
376
|
+
* responsible for cleaning up provisioned resources that remain without an environment connection.</p>
|
|
386
377
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
387
|
-
*
|
|
378
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
388
379
|
*/
|
|
389
380
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentAccountConnectionCommandOutput>;
|
|
390
381
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -397,11 +388,11 @@ export declare class Proton extends ProtonClient {
|
|
|
397
388
|
deleteEnvironmentTemplate(args: DeleteEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void): void;
|
|
398
389
|
/**
|
|
399
390
|
* <p>If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the
|
|
400
|
-
*
|
|
401
|
-
*
|
|
391
|
+
* <code>Recommended</code> version. Delete the <code>Recommended</code> version of the environment template if no other major versions or minor versions
|
|
392
|
+
* of the environment template exist. A major version of an environment template is a version that's not backward compatible.</p>
|
|
402
393
|
* <p>Delete a minor version of an environment template if it <i>isn't</i> the <code>Recommended</code> version. Delete a
|
|
403
|
-
*
|
|
404
|
-
*
|
|
394
|
+
* <code>Recommended</code> minor version of the environment template if no other minor versions of the environment template exist. A minor version of an
|
|
395
|
+
* environment template is a version that's backward compatible.</p>
|
|
405
396
|
*/
|
|
406
397
|
deleteEnvironmentTemplateVersion(args: DeleteEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentTemplateVersionCommandOutput>;
|
|
407
398
|
deleteEnvironmentTemplateVersion(args: DeleteEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
@@ -425,12 +416,12 @@ export declare class Proton extends ProtonClient {
|
|
|
425
416
|
deleteServiceTemplate(args: DeleteServiceTemplateCommandInput, cb: (err: any, data?: DeleteServiceTemplateCommandOutput) => void): void;
|
|
426
417
|
deleteServiceTemplate(args: DeleteServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceTemplateCommandOutput) => void): void;
|
|
427
418
|
/**
|
|
428
|
-
* <p>If no other minor versions of a service template exist, delete a major version of the service template if it's not the
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
* <p>Delete a minor version of a service template if it's not the <code>Recommended</code> version. Delete a <code>Recommended</code> minor version
|
|
432
|
-
*
|
|
433
|
-
*
|
|
419
|
+
* <p>If no other minor versions of a service template exist, delete a major version of the service template if it's not the <code>Recommended</code>
|
|
420
|
+
* version. Delete the <code>Recommended</code> version of the service template if no other major versions or minor versions of the service template exist. A
|
|
421
|
+
* major version of a service template is a version that <i>isn't</i> backwards compatible.</p>
|
|
422
|
+
* <p>Delete a minor version of a service template if it's not the <code>Recommended</code> version. Delete a <code>Recommended</code> minor version of the
|
|
423
|
+
* service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards
|
|
424
|
+
* compatible.</p>
|
|
434
425
|
*/
|
|
435
426
|
deleteServiceTemplateVersion(args: DeleteServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceTemplateVersionCommandOutput>;
|
|
436
427
|
deleteServiceTemplateVersion(args: DeleteServiceTemplateVersionCommandInput, cb: (err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void): void;
|
|
@@ -456,7 +447,7 @@ export declare class Proton extends ProtonClient {
|
|
|
456
447
|
/**
|
|
457
448
|
* <p>In an environment account, view the detail data for an environment account connection.</p>
|
|
458
449
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
459
|
-
*
|
|
450
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
460
451
|
*/
|
|
461
452
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentAccountConnectionCommandOutput>;
|
|
462
453
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -480,7 +471,14 @@ export declare class Proton extends ProtonClient {
|
|
|
480
471
|
getRepository(args: GetRepositoryCommandInput, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void;
|
|
481
472
|
getRepository(args: GetRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void;
|
|
482
473
|
/**
|
|
483
|
-
* <p>Get the repository sync
|
|
474
|
+
* <p>Get the sync status of a repository used for Proton template sync. For more information about template sync, see .</p>
|
|
475
|
+
* <note>
|
|
476
|
+
* <p>A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource
|
|
477
|
+
* have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control
|
|
478
|
+
* (ABAC).</p>
|
|
479
|
+
* <p>For more information about ABAC, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags">ABAC</a> in the <i>Proton
|
|
480
|
+
* Administrator Guide</i>.</p>
|
|
481
|
+
* </note>
|
|
484
482
|
*/
|
|
485
483
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositorySyncStatusCommandOutput>;
|
|
486
484
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void): void;
|
|
@@ -492,8 +490,7 @@ export declare class Proton extends ProtonClient {
|
|
|
492
490
|
getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
|
|
493
491
|
getService(args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
|
|
494
492
|
/**
|
|
495
|
-
* <p>Get detail data for a service instance. A service instance is an instantiation of service template
|
|
496
|
-
* environment.</p>
|
|
493
|
+
* <p>Get detail data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.</p>
|
|
497
494
|
*/
|
|
498
495
|
getServiceInstance(args: GetServiceInstanceCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceInstanceCommandOutput>;
|
|
499
496
|
getServiceInstance(args: GetServiceInstanceCommandInput, cb: (err: any, data?: GetServiceInstanceCommandOutput) => void): void;
|
|
@@ -525,7 +522,7 @@ export declare class Proton extends ProtonClient {
|
|
|
525
522
|
/**
|
|
526
523
|
* <p>View a list of environment account connections.</p>
|
|
527
524
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
528
|
-
*
|
|
525
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
529
526
|
*/
|
|
530
527
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentAccountConnectionsCommandOutput>;
|
|
531
528
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, cb: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void): void;
|
|
@@ -627,36 +624,33 @@ export declare class Proton extends ProtonClient {
|
|
|
627
624
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
628
625
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
629
626
|
/**
|
|
630
|
-
* <p>Notify Proton of status changes to a provisioned resource when you use
|
|
631
|
-
* <
|
|
632
|
-
* <p>Provisioning by pull request is currently in feature preview and is
|
|
633
|
-
* only usable with Terraform based Proton Templates. To learn more about
|
|
634
|
-
* <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
|
|
635
|
-
* Previews.</p>
|
|
636
|
-
* </important>
|
|
627
|
+
* <p>Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.</p>
|
|
628
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton Administrator Guide</i>.</p>
|
|
637
629
|
*/
|
|
638
630
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, options?: __HttpHandlerOptions): Promise<NotifyResourceDeploymentStatusChangeCommandOutput>;
|
|
639
631
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void): void;
|
|
640
632
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void): void;
|
|
641
633
|
/**
|
|
642
634
|
* <p>In a management account, reject an environment account connection from another environment account.</p>
|
|
643
|
-
* <p>After you reject an environment account connection request, you <i>
|
|
644
|
-
*
|
|
645
|
-
* <p>You <i>can’t</i> reject an environment account connection that
|
|
635
|
+
* <p>After you reject an environment account connection request, you <i>can't</i> accept or use the rejected environment account
|
|
636
|
+
* connection.</p>
|
|
637
|
+
* <p>You <i>can’t</i> reject an environment account connection that's connected to an environment.</p>
|
|
646
638
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
647
|
-
*
|
|
639
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
648
640
|
*/
|
|
649
641
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<RejectEnvironmentAccountConnectionCommandOutput>;
|
|
650
642
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
651
643
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
652
644
|
/**
|
|
653
|
-
* <p>Tag a resource.
|
|
645
|
+
* <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p>
|
|
646
|
+
* <p>For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
|
|
654
647
|
*/
|
|
655
648
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
656
649
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
657
650
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
658
651
|
/**
|
|
659
|
-
* <p>Remove a tag from a resource.
|
|
652
|
+
* <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.</p>
|
|
653
|
+
* <p>For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
|
|
660
654
|
*/
|
|
661
655
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
662
656
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
@@ -670,18 +664,20 @@ export declare class Proton extends ProtonClient {
|
|
|
670
664
|
/**
|
|
671
665
|
* <p>Update an environment.</p>
|
|
672
666
|
* <p>If the environment is associated with an environment account connection, <i>don't</i> update or include the
|
|
673
|
-
*
|
|
674
|
-
*
|
|
675
|
-
*
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
* <p>You can update either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. You can’t
|
|
680
|
-
*
|
|
681
|
-
* <p>If the environment was
|
|
682
|
-
*
|
|
683
|
-
*
|
|
684
|
-
* <p>
|
|
667
|
+
* <code>protonServiceRoleArn</code> and <code>provisioningRepository</code> parameter to update or connect to an environment account connection.</p>
|
|
668
|
+
* <p>You can only update to a new environment account connection if that connection was created in the same environment account that the current
|
|
669
|
+
* environment account connection was created in. The account connection must also be associated with the current environment.</p>
|
|
670
|
+
* <p>If the environment <i>isn't</i> associated with an environment account connection, <i>don't</i> update or include the
|
|
671
|
+
* <code>environmentAccountConnectionId</code> parameter. You <i>can't</i> update or connect the environment to an environment account
|
|
672
|
+
* connection if it <i>isn't</i> already associated with an environment connection.</p>
|
|
673
|
+
* <p>You can update either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. You can’t update
|
|
674
|
+
* both.</p>
|
|
675
|
+
* <p>If the environment was configured for Amazon Web Services-managed provisioning, omit the <code>provisioningRepository</code> parameter.</p>
|
|
676
|
+
* <p>If the environment was configured for self-managed provisioning, specify the <code>provisioningRepository</code> parameter and omit the
|
|
677
|
+
* <code>protonServiceRoleArn</code> and <code>environmentAccountConnectionId</code> parameters.</p>
|
|
678
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton Administrator
|
|
679
|
+
* Guide</i>.</p>
|
|
680
|
+
* <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
|
|
685
681
|
* <dl>
|
|
686
682
|
* <dt/>
|
|
687
683
|
* <dd>
|
|
@@ -696,24 +692,23 @@ export declare class Proton extends ProtonClient {
|
|
|
696
692
|
* <code>CURRENT_VERSION</code>
|
|
697
693
|
* </p>
|
|
698
694
|
* <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
699
|
-
*
|
|
695
|
+
* <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p>
|
|
700
696
|
* </dd>
|
|
701
697
|
* <dt/>
|
|
702
698
|
* <dd>
|
|
703
699
|
* <p>
|
|
704
700
|
* <code>MINOR_VERSION</code>
|
|
705
701
|
* </p>
|
|
706
|
-
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version
|
|
707
|
-
*
|
|
702
|
+
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in
|
|
703
|
+
* use, by default. You can also specify a different minor version of the current major version in use.</p>
|
|
708
704
|
* </dd>
|
|
709
705
|
* <dt/>
|
|
710
706
|
* <dd>
|
|
711
707
|
* <p>
|
|
712
708
|
* <code>MAJOR_VERSION</code>
|
|
713
709
|
* </p>
|
|
714
|
-
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current
|
|
715
|
-
*
|
|
716
|
-
* (optional).</p>
|
|
710
|
+
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template,
|
|
711
|
+
* by default. You can also specify a different major version that's higher than the major version in use and a minor version.</p>
|
|
717
712
|
* </dd>
|
|
718
713
|
* </dl>
|
|
719
714
|
*/
|
|
@@ -723,7 +718,7 @@ export declare class Proton extends ProtonClient {
|
|
|
723
718
|
/**
|
|
724
719
|
* <p>In an environment account, update an environment account connection to use a new IAM role.</p>
|
|
725
720
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
|
|
726
|
-
*
|
|
721
|
+
* connections</a> in the <i>Proton Administrator guide</i>.</p>
|
|
727
722
|
*/
|
|
728
723
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentAccountConnectionCommandOutput>;
|
|
729
724
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -753,8 +748,7 @@ export declare class Proton extends ProtonClient {
|
|
|
753
748
|
updateService(args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
|
|
754
749
|
/**
|
|
755
750
|
* <p>Update a service instance.</p>
|
|
756
|
-
* <p>There are four modes for updating a service instance
|
|
757
|
-
* mode.</p>
|
|
751
|
+
* <p>There are four modes for updating a service instance. The <code>deploymentType</code> field defines the mode.</p>
|
|
758
752
|
* <dl>
|
|
759
753
|
* <dt/>
|
|
760
754
|
* <dd>
|
|
@@ -769,15 +763,15 @@ export declare class Proton extends ProtonClient {
|
|
|
769
763
|
* <code>CURRENT_VERSION</code>
|
|
770
764
|
* </p>
|
|
771
765
|
* <p>In this mode, the service instance is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
772
|
-
*
|
|
766
|
+
* <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p>
|
|
773
767
|
* </dd>
|
|
774
768
|
* <dt/>
|
|
775
769
|
* <dd>
|
|
776
770
|
* <p>
|
|
777
771
|
* <code>MINOR_VERSION</code>
|
|
778
772
|
* </p>
|
|
779
|
-
* <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major
|
|
780
|
-
*
|
|
773
|
+
* <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) minor version of the current major version
|
|
774
|
+
* in use, by default. You can also specify a different minor version of the current major version in use.</p>
|
|
781
775
|
* </dd>
|
|
782
776
|
* <dt/>
|
|
783
777
|
* <dd>
|
|
@@ -785,8 +779,7 @@ export declare class Proton extends ProtonClient {
|
|
|
785
779
|
* <code>MAJOR_VERSION</code>
|
|
786
780
|
* </p>
|
|
787
781
|
* <p>In this mode, the service instance is deployed and updated with the published, recommended (latest) major and minor version of the current
|
|
788
|
-
*
|
|
789
|
-
* (optional).</p>
|
|
782
|
+
* template, by default. You can also specify a different major version that's higher than the major version in use and a minor version.</p>
|
|
790
783
|
* </dd>
|
|
791
784
|
* </dl>
|
|
792
785
|
*/
|
|
@@ -795,8 +788,7 @@ export declare class Proton extends ProtonClient {
|
|
|
795
788
|
updateServiceInstance(args: UpdateServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceInstanceCommandOutput) => void): void;
|
|
796
789
|
/**
|
|
797
790
|
* <p>Update the service pipeline.</p>
|
|
798
|
-
* <p>There are four modes for updating a service pipeline
|
|
799
|
-
* mode.</p>
|
|
791
|
+
* <p>There are four modes for updating a service pipeline. The <code>deploymentType</code> field defines the mode.</p>
|
|
800
792
|
* <dl>
|
|
801
793
|
* <dt/>
|
|
802
794
|
* <dd>
|
|
@@ -811,15 +803,15 @@ export declare class Proton extends ProtonClient {
|
|
|
811
803
|
* <code>CURRENT_VERSION</code>
|
|
812
804
|
* </p>
|
|
813
805
|
* <p>In this mode, the service pipeline is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
814
|
-
*
|
|
806
|
+
* <i>Don’t</i> include major or minor version parameters when you use this <code>deployment-type</code>.</p>
|
|
815
807
|
* </dd>
|
|
816
808
|
* <dt/>
|
|
817
809
|
* <dd>
|
|
818
810
|
* <p>
|
|
819
811
|
* <code>MINOR_VERSION</code>
|
|
820
812
|
* </p>
|
|
821
|
-
* <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major
|
|
822
|
-
*
|
|
813
|
+
* <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) minor version of the current major version
|
|
814
|
+
* in use, by default. You can specify a different minor version of the current major version in use.</p>
|
|
823
815
|
* </dd>
|
|
824
816
|
* <dt/>
|
|
825
817
|
* <dd>
|
|
@@ -827,8 +819,7 @@ export declare class Proton extends ProtonClient {
|
|
|
827
819
|
* <code>MAJOR_VERSION</code>
|
|
828
820
|
* </p>
|
|
829
821
|
* <p>In this mode, the service pipeline is deployed and updated with the published, recommended (latest) major and minor version of the current
|
|
830
|
-
*
|
|
831
|
-
* (optional).</p>
|
|
822
|
+
* template by default. You can specify a different major version that's higher than the major version in use and a minor version.</p>
|
|
832
823
|
* </dd>
|
|
833
824
|
* </dl>
|
|
834
825
|
*/
|