@aws-sdk/client-proton 3.315.0 → 3.319.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/dist-cjs/Proton.js +88 -1176
- package/dist-cjs/protocols/Aws_json1_0.js +7 -7
- package/dist-es/Proton.js +88 -1176
- package/dist-es/protocols/Aws_json1_0.js +7 -7
- package/dist-types/Proton.d.ts +219 -623
- package/dist-types/ts3.4/Proton.d.ts +2 -1
- package/package.json +8 -8
package/dist-types/Proton.d.ts
CHANGED
|
@@ -84,1047 +84,643 @@ import { UpdateServiceTemplateCommandInput, UpdateServiceTemplateCommandOutput }
|
|
|
84
84
|
import { UpdateServiceTemplateVersionCommandInput, UpdateServiceTemplateVersionCommandOutput } from "./commands/UpdateServiceTemplateVersionCommand";
|
|
85
85
|
import { UpdateTemplateSyncConfigCommandInput, UpdateTemplateSyncConfigCommandOutput } from "./commands/UpdateTemplateSyncConfigCommand";
|
|
86
86
|
import { ProtonClient } from "./ProtonClient";
|
|
87
|
-
|
|
88
|
-
* @public
|
|
89
|
-
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
90
|
-
* <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
|
|
91
|
-
* service.</p>
|
|
92
|
-
* <p>The documentation for each action shows the Query API request parameters and the XML response.</p>
|
|
93
|
-
* <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
|
|
94
|
-
* Guide</a>.</p>
|
|
95
|
-
* <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide
|
|
96
|
-
* standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in
|
|
97
|
-
* turn, select from the available service templates to automate their application or service deployments.</p>
|
|
98
|
-
* <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need
|
|
99
|
-
* permissions to use all of the listed API operations.</p>
|
|
100
|
-
* <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To
|
|
101
|
-
* monitor their applications that are running on Proton, developers need permissions to the service
|
|
102
|
-
* <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i>
|
|
103
|
-
* API operations and the service instance <i>list</i> and <i>update</i> API
|
|
104
|
-
* operations.</p>
|
|
105
|
-
* <p>To learn more about Proton, see the <a href="https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html">Proton User Guide</a>.</p>
|
|
106
|
-
* <p>
|
|
107
|
-
* <b>Ensuring Idempotency</b>
|
|
108
|
-
* </p>
|
|
109
|
-
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
110
|
-
* of the operation are complete. Operations might also time out or encounter other server issues before they're
|
|
111
|
-
* complete, even if the request already returned a result. This might make it difficult to determine whether the
|
|
112
|
-
* request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation
|
|
113
|
-
* completes successfully. However, if the original request and the subsequent retries are successful, the operation
|
|
114
|
-
* occurs multiple times. This means that you might create more resources than you intended.</p>
|
|
115
|
-
* <p>
|
|
116
|
-
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
117
|
-
* idempotent request, if the original request action completes successfully, any subsequent retries complete
|
|
118
|
-
* successfully without performing any further actions. However, the result might contain updated information, such as
|
|
119
|
-
* the current creation status.</p>
|
|
120
|
-
* <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
|
|
121
|
-
* <p>
|
|
122
|
-
* <b>Idempotent create APIs with a client token</b>
|
|
123
|
-
* </p>
|
|
124
|
-
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
125
|
-
* corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,
|
|
126
|
-
* case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,
|
|
127
|
-
* specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token
|
|
128
|
-
* for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically
|
|
129
|
-
* provided by SDKs.</p>
|
|
130
|
-
* <p>Given a request action that has succeeded:</p>
|
|
131
|
-
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
132
|
-
* performing any further actions other than returning the original resource detail data in the response.</p>
|
|
133
|
-
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
134
|
-
* throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
|
|
135
|
-
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
136
|
-
* resource is created.</p>
|
|
137
|
-
* <p>If the original resource is deleted and you retry the request, a new resource is created.</p>
|
|
138
|
-
* <p>Idempotent create APIs with a client token:</p>
|
|
139
|
-
* <ul>
|
|
140
|
-
* <li>
|
|
141
|
-
* <p>CreateEnvironmentTemplateVersion</p>
|
|
142
|
-
* </li>
|
|
143
|
-
* <li>
|
|
144
|
-
* <p>CreateServiceTemplateVersion</p>
|
|
145
|
-
* </li>
|
|
146
|
-
* <li>
|
|
147
|
-
* <p>CreateEnvironmentAccountConnection</p>
|
|
148
|
-
* </li>
|
|
149
|
-
* </ul>
|
|
150
|
-
* <p>
|
|
151
|
-
* <b>Idempotent create APIs</b>
|
|
152
|
-
* </p>
|
|
153
|
-
* <p>Given a request action that has succeeded:</p>
|
|
154
|
-
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
155
|
-
* modified, the retry succeeds without performing any further actions other than returning the original resource detail
|
|
156
|
-
* data in the response.</p>
|
|
157
|
-
* <p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
|
|
158
|
-
* <p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
|
|
159
|
-
* <code>IdempotentParameterMismatch</code> error.</p>
|
|
160
|
-
* <p>Idempotent create APIs:</p>
|
|
161
|
-
* <ul>
|
|
162
|
-
* <li>
|
|
163
|
-
* <p>CreateEnvironmentTemplate</p>
|
|
164
|
-
* </li>
|
|
165
|
-
* <li>
|
|
166
|
-
* <p>CreateServiceTemplate</p>
|
|
167
|
-
* </li>
|
|
168
|
-
* <li>
|
|
169
|
-
* <p>CreateEnvironment</p>
|
|
170
|
-
* </li>
|
|
171
|
-
* <li>
|
|
172
|
-
* <p>CreateService</p>
|
|
173
|
-
* </li>
|
|
174
|
-
* </ul>
|
|
175
|
-
* <p>
|
|
176
|
-
* <b>Idempotent delete APIs</b>
|
|
177
|
-
* </p>
|
|
178
|
-
* <p>Given a request action that has succeeded:</p>
|
|
179
|
-
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
180
|
-
* the response.</p>
|
|
181
|
-
* <p>If you retry and the resource doesn't exist, the response is empty.</p>
|
|
182
|
-
* <p>In both cases, the retry succeeds.</p>
|
|
183
|
-
* <p>Idempotent delete APIs:</p>
|
|
184
|
-
* <ul>
|
|
185
|
-
* <li>
|
|
186
|
-
* <p>DeleteEnvironmentTemplate</p>
|
|
187
|
-
* </li>
|
|
188
|
-
* <li>
|
|
189
|
-
* <p>DeleteEnvironmentTemplateVersion</p>
|
|
190
|
-
* </li>
|
|
191
|
-
* <li>
|
|
192
|
-
* <p>DeleteServiceTemplate</p>
|
|
193
|
-
* </li>
|
|
194
|
-
* <li>
|
|
195
|
-
* <p>DeleteServiceTemplateVersion</p>
|
|
196
|
-
* </li>
|
|
197
|
-
* <li>
|
|
198
|
-
* <p>DeleteEnvironmentAccountConnection</p>
|
|
199
|
-
* </li>
|
|
200
|
-
* </ul>
|
|
201
|
-
* <p>
|
|
202
|
-
* <b>Asynchronous idempotent delete APIs</b>
|
|
203
|
-
* </p>
|
|
204
|
-
* <p>Given a request action that has succeeded:</p>
|
|
205
|
-
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
206
|
-
* <code>DELETE_IN_PROGRESS</code>, the retry returns the resource detail data in the response without performing any
|
|
207
|
-
* further actions.</p>
|
|
208
|
-
* <p>If the original request delete operation is complete, a retry returns an empty response.</p>
|
|
209
|
-
* <p>Asynchronous idempotent delete APIs:</p>
|
|
210
|
-
* <ul>
|
|
211
|
-
* <li>
|
|
212
|
-
* <p>DeleteEnvironment</p>
|
|
213
|
-
* </li>
|
|
214
|
-
* <li>
|
|
215
|
-
* <p>DeleteService</p>
|
|
216
|
-
* </li>
|
|
217
|
-
* </ul>
|
|
218
|
-
*/
|
|
219
|
-
export declare class Proton extends ProtonClient {
|
|
87
|
+
export interface Proton {
|
|
220
88
|
/**
|
|
221
|
-
* @
|
|
222
|
-
* <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton
|
|
223
|
-
* can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p>
|
|
224
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
225
|
-
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
89
|
+
* @see {@link AcceptEnvironmentAccountConnectionCommand}
|
|
226
90
|
*/
|
|
227
91
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<AcceptEnvironmentAccountConnectionCommandOutput>;
|
|
228
92
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
229
93
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
230
94
|
/**
|
|
231
|
-
* @
|
|
232
|
-
* <p>Attempts to cancel a component deployment (for a component that is in the <code>IN_PROGRESS</code> deployment status).</p>
|
|
233
|
-
* <p>For more information about components, see
|
|
234
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
235
|
-
* <i>Proton User Guide</i>.</p>
|
|
95
|
+
* @see {@link CancelComponentDeploymentCommand}
|
|
236
96
|
*/
|
|
237
97
|
cancelComponentDeployment(args: CancelComponentDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CancelComponentDeploymentCommandOutput>;
|
|
238
98
|
cancelComponentDeployment(args: CancelComponentDeploymentCommandInput, cb: (err: any, data?: CancelComponentDeploymentCommandOutput) => void): void;
|
|
239
99
|
cancelComponentDeployment(args: CancelComponentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelComponentDeploymentCommandOutput) => void): void;
|
|
240
100
|
/**
|
|
241
|
-
* @
|
|
242
|
-
* <p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more
|
|
243
|
-
* information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html">Update an environment</a> in the <i>Proton
|
|
244
|
-
* User guide</i>.</p>
|
|
245
|
-
* <p>The following list includes potential cancellation scenarios.</p>
|
|
246
|
-
* <ul>
|
|
247
|
-
* <li>
|
|
248
|
-
* <p>If the cancellation attempt succeeds, the resulting deployment state is <code>CANCELLED</code>.</p>
|
|
249
|
-
* </li>
|
|
250
|
-
* <li>
|
|
251
|
-
* <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p>
|
|
252
|
-
* </li>
|
|
253
|
-
* <li>
|
|
254
|
-
* <p>If the current <a>UpdateEnvironment</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
|
|
255
|
-
* <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
|
|
256
|
-
* </li>
|
|
257
|
-
* </ul>
|
|
101
|
+
* @see {@link CancelEnvironmentDeploymentCommand}
|
|
258
102
|
*/
|
|
259
103
|
cancelEnvironmentDeployment(args: CancelEnvironmentDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CancelEnvironmentDeploymentCommandOutput>;
|
|
260
104
|
cancelEnvironmentDeployment(args: CancelEnvironmentDeploymentCommandInput, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void): void;
|
|
261
105
|
cancelEnvironmentDeployment(args: CancelEnvironmentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void): void;
|
|
262
106
|
/**
|
|
263
|
-
* @
|
|
264
|
-
* <p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>. For
|
|
265
|
-
* more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html">Update a service instance</a>
|
|
266
|
-
* in the <i>Proton User guide</i>.</p>
|
|
267
|
-
* <p>The following list includes potential cancellation scenarios.</p>
|
|
268
|
-
* <ul>
|
|
269
|
-
* <li>
|
|
270
|
-
* <p>If the cancellation attempt succeeds, the resulting deployment state is
|
|
271
|
-
* <code>CANCELLED</code>.</p>
|
|
272
|
-
* </li>
|
|
273
|
-
* <li>
|
|
274
|
-
* <p>If the cancellation attempt fails, the resulting deployment state is
|
|
275
|
-
* <code>FAILED</code>.</p>
|
|
276
|
-
* </li>
|
|
277
|
-
* <li>
|
|
278
|
-
* <p>If the current <a>UpdateServiceInstance</a> action succeeds before the
|
|
279
|
-
* cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and
|
|
280
|
-
* the cancellation attempt has no effect.</p>
|
|
281
|
-
* </li>
|
|
282
|
-
* </ul>
|
|
107
|
+
* @see {@link CancelServiceInstanceDeploymentCommand}
|
|
283
108
|
*/
|
|
284
109
|
cancelServiceInstanceDeployment(args: CancelServiceInstanceDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CancelServiceInstanceDeploymentCommandOutput>;
|
|
285
110
|
cancelServiceInstanceDeployment(args: CancelServiceInstanceDeploymentCommandInput, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void): void;
|
|
286
111
|
cancelServiceInstanceDeployment(args: CancelServiceInstanceDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void): void;
|
|
287
112
|
/**
|
|
288
|
-
* @
|
|
289
|
-
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>. For
|
|
290
|
-
* more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html">Update a service pipeline</a>
|
|
291
|
-
* in the <i>Proton User guide</i>.</p>
|
|
292
|
-
* <p>The following list includes potential cancellation scenarios.</p>
|
|
293
|
-
* <ul>
|
|
294
|
-
* <li>
|
|
295
|
-
* <p>If the cancellation attempt succeeds, the resulting deployment state is
|
|
296
|
-
* <code>CANCELLED</code>.</p>
|
|
297
|
-
* </li>
|
|
298
|
-
* <li>
|
|
299
|
-
* <p>If the cancellation attempt fails, the resulting deployment state is
|
|
300
|
-
* <code>FAILED</code>.</p>
|
|
301
|
-
* </li>
|
|
302
|
-
* <li>
|
|
303
|
-
* <p>If the current <a>UpdateServicePipeline</a> action succeeds before the
|
|
304
|
-
* cancellation attempt starts, the resulting deployment state is <code>SUCCEEDED</code> and
|
|
305
|
-
* the cancellation attempt has no effect.</p>
|
|
306
|
-
* </li>
|
|
307
|
-
* </ul>
|
|
113
|
+
* @see {@link CancelServicePipelineDeploymentCommand}
|
|
308
114
|
*/
|
|
309
115
|
cancelServicePipelineDeployment(args: CancelServicePipelineDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CancelServicePipelineDeploymentCommandOutput>;
|
|
310
116
|
cancelServicePipelineDeployment(args: CancelServicePipelineDeploymentCommandInput, cb: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void): void;
|
|
311
117
|
cancelServicePipelineDeployment(args: CancelServicePipelineDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServicePipelineDeploymentCommandOutput) => void): void;
|
|
312
118
|
/**
|
|
313
|
-
* @
|
|
314
|
-
* <p>Create an Proton component. A component is an infrastructure extension for a service instance.</p>
|
|
315
|
-
* <p>For more information about components, see
|
|
316
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
317
|
-
* <i>Proton User Guide</i>.</p>
|
|
119
|
+
* @see {@link CreateComponentCommand}
|
|
318
120
|
*/
|
|
319
121
|
createComponent(args: CreateComponentCommandInput, options?: __HttpHandlerOptions): Promise<CreateComponentCommandOutput>;
|
|
320
122
|
createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void;
|
|
321
123
|
createComponent(args: CreateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateComponentCommandOutput) => void): void;
|
|
322
124
|
/**
|
|
323
|
-
* @
|
|
324
|
-
* <p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be
|
|
325
|
-
* shared across services.</p>
|
|
326
|
-
* <p class="title">
|
|
327
|
-
* <b>You can provision environments using the following methods:</b>
|
|
328
|
-
* </p>
|
|
329
|
-
* <ul>
|
|
330
|
-
* <li>
|
|
331
|
-
* <p>Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.</p>
|
|
332
|
-
* </li>
|
|
333
|
-
* <li>
|
|
334
|
-
* <p>Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC
|
|
335
|
-
* engine uses to provision resources.</p>
|
|
336
|
-
* </li>
|
|
337
|
-
* </ul>
|
|
338
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton User
|
|
339
|
-
* Guide</i>.</p>
|
|
125
|
+
* @see {@link CreateEnvironmentCommand}
|
|
340
126
|
*/
|
|
341
127
|
createEnvironment(args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentCommandOutput>;
|
|
342
128
|
createEnvironment(args: CreateEnvironmentCommandInput, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
|
|
343
129
|
createEnvironment(args: CreateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentCommandOutput) => void): void;
|
|
344
130
|
/**
|
|
345
|
-
* @
|
|
346
|
-
* <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment
|
|
347
|
-
* account from a management account.</p>
|
|
348
|
-
* <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an <i>environment
|
|
349
|
-
* account</i> that maintains authorization and permissions. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton User
|
|
350
|
-
* guide</i>.</p>
|
|
131
|
+
* @see {@link CreateEnvironmentAccountConnectionCommand}
|
|
351
132
|
*/
|
|
352
133
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentAccountConnectionCommandOutput>;
|
|
353
134
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
354
135
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
355
136
|
/**
|
|
356
|
-
* @
|
|
357
|
-
* <p>Create an environment template for Proton. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Environment Templates</a> in the <i>Proton User Guide</i>.</p>
|
|
358
|
-
* <p>You can create an environment template in one of the two following ways:</p>
|
|
359
|
-
* <ul>
|
|
360
|
-
* <li>
|
|
361
|
-
* <p>Register and publish a <i>standard</i> environment template that instructs Proton to deploy and manage environment
|
|
362
|
-
* infrastructure.</p>
|
|
363
|
-
* </li>
|
|
364
|
-
* <li>
|
|
365
|
-
* <p>Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned
|
|
366
|
-
* infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment
|
|
367
|
-
* template for customer provisioned and managed infrastructure, include the <code>provisioning</code> parameter and set the value to
|
|
368
|
-
* <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/template-create.html">Register
|
|
369
|
-
* and publish an environment template</a> in the <i>Proton User Guide</i>.</p>
|
|
370
|
-
* </li>
|
|
371
|
-
* </ul>
|
|
137
|
+
* @see {@link CreateEnvironmentTemplateCommand}
|
|
372
138
|
*/
|
|
373
139
|
createEnvironmentTemplate(args: CreateEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentTemplateCommandOutput>;
|
|
374
140
|
createEnvironmentTemplate(args: CreateEnvironmentTemplateCommandInput, cb: (err: any, data?: CreateEnvironmentTemplateCommandOutput) => void): void;
|
|
375
141
|
createEnvironmentTemplate(args: CreateEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateCommandOutput) => void): void;
|
|
376
142
|
/**
|
|
377
|
-
* @
|
|
378
|
-
* <p>Create a new major or minor version of an environment template. A major version of an environment template is a version that
|
|
379
|
-
* <i>isn't</i> backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major
|
|
380
|
-
* version.</p>
|
|
143
|
+
* @see {@link CreateEnvironmentTemplateVersionCommand}
|
|
381
144
|
*/
|
|
382
145
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentTemplateVersionCommandOutput>;
|
|
383
146
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
384
147
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
385
148
|
/**
|
|
386
|
-
* @
|
|
387
|
-
* <p>Create and register a link to a repository. Proton uses the link to repeatedly access the repository, to either push to it (self-managed
|
|
388
|
-
* provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed
|
|
389
|
-
* provisioning, or synced templates). When you create a repository link, Proton creates a <a href="https://docs.aws.amazon.com/proton/latest/userguide/using-service-linked-roles.html">service-linked role</a> for you.</p>
|
|
390
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a>, <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-authoring.html#ag-template-bundles">Template bundles</a>, and
|
|
391
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
|
|
392
|
-
* User Guide</i>.</p>
|
|
149
|
+
* @see {@link CreateRepositoryCommand}
|
|
393
150
|
*/
|
|
394
151
|
createRepository(args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<CreateRepositoryCommandOutput>;
|
|
395
152
|
createRepository(args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
|
|
396
153
|
createRepository(args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
|
|
397
154
|
/**
|
|
398
|
-
* @
|
|
399
|
-
* <p>Create an Proton service. An Proton service is an instantiation of a service
|
|
400
|
-
* template and often includes several service instances and pipeline. For more information, see
|
|
401
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html">Services</a>
|
|
402
|
-
* in the <i>Proton User Guide</i>.</p>
|
|
155
|
+
* @see {@link CreateServiceCommand}
|
|
403
156
|
*/
|
|
404
157
|
createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceCommandOutput>;
|
|
405
158
|
createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
406
159
|
createService(args: CreateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
407
160
|
/**
|
|
408
|
-
* @
|
|
409
|
-
* <p>Create a service instance.</p>
|
|
161
|
+
* @see {@link CreateServiceInstanceCommand}
|
|
410
162
|
*/
|
|
411
163
|
createServiceInstance(args: CreateServiceInstanceCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceInstanceCommandOutput>;
|
|
412
164
|
createServiceInstance(args: CreateServiceInstanceCommandInput, cb: (err: any, data?: CreateServiceInstanceCommandOutput) => void): void;
|
|
413
165
|
createServiceInstance(args: CreateServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceInstanceCommandOutput) => void): void;
|
|
414
166
|
/**
|
|
415
|
-
* @
|
|
416
|
-
* <p>Create the Proton Ops configuration file.</p>
|
|
167
|
+
* @see {@link CreateServiceSyncConfigCommand}
|
|
417
168
|
*/
|
|
418
169
|
createServiceSyncConfig(args: CreateServiceSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceSyncConfigCommandOutput>;
|
|
419
170
|
createServiceSyncConfig(args: CreateServiceSyncConfigCommandInput, cb: (err: any, data?: CreateServiceSyncConfigCommandOutput) => void): void;
|
|
420
171
|
createServiceSyncConfig(args: CreateServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceSyncConfigCommandOutput) => void): void;
|
|
421
172
|
/**
|
|
422
|
-
* @
|
|
423
|
-
* <p>Create a service template. The administrator creates a service template to define
|
|
424
|
-
* standardized infrastructure and an optional CI/CD service pipeline. Developers, in turn,
|
|
425
|
-
* select the service template from Proton. If the selected service template includes a
|
|
426
|
-
* service pipeline definition, they provide a link to their source code repository. Proton
|
|
427
|
-
* then deploys and manages the infrastructure defined by the selected service template. For more
|
|
428
|
-
* information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Proton templates</a> in the <i>Proton User Guide</i>.</p>
|
|
173
|
+
* @see {@link CreateServiceTemplateCommand}
|
|
429
174
|
*/
|
|
430
175
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceTemplateCommandOutput>;
|
|
431
176
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void): void;
|
|
432
177
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void): void;
|
|
433
178
|
/**
|
|
434
|
-
* @
|
|
435
|
-
* <p>Create a new major or minor version of a service template. A major version of a service
|
|
436
|
-
* template is a version that <i>isn't</i> backward compatible. A minor version of
|
|
437
|
-
* a service template is a version that's backward compatible within its major version.</p>
|
|
179
|
+
* @see {@link CreateServiceTemplateVersionCommand}
|
|
438
180
|
*/
|
|
439
181
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceTemplateVersionCommandOutput>;
|
|
440
182
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
441
183
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
442
184
|
/**
|
|
443
|
-
* @
|
|
444
|
-
* <p>Set up a template to create new template versions automatically by tracking a linked
|
|
445
|
-
* repository. A linked repository is a repository that has been registered with Proton. For more
|
|
446
|
-
* information, see <a>CreateRepository</a>.</p>
|
|
447
|
-
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your
|
|
448
|
-
* repository template bundles. If it detects a template bundle change, a new major or minor version
|
|
449
|
-
* of its template is created, if the version doesn’t already exist. For more information, see
|
|
450
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template
|
|
451
|
-
* sync configurations</a> in the <i>Proton User Guide</i>.</p>
|
|
185
|
+
* @see {@link CreateTemplateSyncConfigCommand}
|
|
452
186
|
*/
|
|
453
187
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateSyncConfigCommandOutput>;
|
|
454
188
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void): void;
|
|
455
189
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void): void;
|
|
456
190
|
/**
|
|
457
|
-
* @
|
|
458
|
-
* <p>Delete an Proton component resource.</p>
|
|
459
|
-
* <p>For more information about components, see
|
|
460
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
461
|
-
* <i>Proton User Guide</i>.</p>
|
|
191
|
+
* @see {@link DeleteComponentCommand}
|
|
462
192
|
*/
|
|
463
193
|
deleteComponent(args: DeleteComponentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteComponentCommandOutput>;
|
|
464
194
|
deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
|
|
465
195
|
deleteComponent(args: DeleteComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
|
|
466
196
|
/**
|
|
467
|
-
* @
|
|
468
|
-
* <p>Delete an environment.</p>
|
|
197
|
+
* @see {@link DeleteEnvironmentCommand}
|
|
469
198
|
*/
|
|
470
199
|
deleteEnvironment(args: DeleteEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentCommandOutput>;
|
|
471
200
|
deleteEnvironment(args: DeleteEnvironmentCommandInput, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
|
|
472
201
|
deleteEnvironment(args: DeleteEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentCommandOutput) => void): void;
|
|
473
202
|
/**
|
|
474
|
-
* @
|
|
475
|
-
* <p>In an environment account, delete an environment account connection.</p>
|
|
476
|
-
* <p>After you delete an environment account connection that’s in use by an Proton environment, Proton <i>can’t</i> manage the
|
|
477
|
-
* environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're
|
|
478
|
-
* responsible for cleaning up provisioned resources that remain without an environment connection.</p>
|
|
479
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
480
|
-
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
203
|
+
* @see {@link DeleteEnvironmentAccountConnectionCommand}
|
|
481
204
|
*/
|
|
482
205
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentAccountConnectionCommandOutput>;
|
|
483
206
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
484
207
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
485
208
|
/**
|
|
486
|
-
* @
|
|
487
|
-
* <p>If no other major or minor versions of an environment template exist, delete the environment template.</p>
|
|
209
|
+
* @see {@link DeleteEnvironmentTemplateCommand}
|
|
488
210
|
*/
|
|
489
211
|
deleteEnvironmentTemplate(args: DeleteEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentTemplateCommandOutput>;
|
|
490
212
|
deleteEnvironmentTemplate(args: DeleteEnvironmentTemplateCommandInput, cb: (err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void): void;
|
|
491
213
|
deleteEnvironmentTemplate(args: DeleteEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentTemplateCommandOutput) => void): void;
|
|
492
214
|
/**
|
|
493
|
-
* @
|
|
494
|
-
* <p>If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the
|
|
495
|
-
* <code>Recommended</code> version. Delete the <code>Recommended</code> version of the environment template if no other major versions or minor versions
|
|
496
|
-
* of the environment template exist. A major version of an environment template is a version that's not backward compatible.</p>
|
|
497
|
-
* <p>Delete a minor version of an environment template if it <i>isn't</i> the <code>Recommended</code> version. Delete a
|
|
498
|
-
* <code>Recommended</code> minor version of the environment template if no other minor versions of the environment template exist. A minor version of an
|
|
499
|
-
* environment template is a version that's backward compatible.</p>
|
|
215
|
+
* @see {@link DeleteEnvironmentTemplateVersionCommand}
|
|
500
216
|
*/
|
|
501
217
|
deleteEnvironmentTemplateVersion(args: DeleteEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentTemplateVersionCommandOutput>;
|
|
502
218
|
deleteEnvironmentTemplateVersion(args: DeleteEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
503
219
|
deleteEnvironmentTemplateVersion(args: DeleteEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
504
220
|
/**
|
|
505
|
-
* @
|
|
506
|
-
* <p>De-register and unlink your repository.</p>
|
|
221
|
+
* @see {@link DeleteRepositoryCommand}
|
|
507
222
|
*/
|
|
508
223
|
deleteRepository(args: DeleteRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRepositoryCommandOutput>;
|
|
509
224
|
deleteRepository(args: DeleteRepositoryCommandInput, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
|
|
510
225
|
deleteRepository(args: DeleteRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRepositoryCommandOutput) => void): void;
|
|
511
226
|
/**
|
|
512
|
-
* @
|
|
513
|
-
* <p>Delete a service, with its instances and pipeline.</p>
|
|
514
|
-
* <note>
|
|
515
|
-
* <p>You can't delete a service if it has any service instances that have components attached
|
|
516
|
-
* to them.</p>
|
|
517
|
-
* <p>For more information about components, see
|
|
518
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
519
|
-
* <i>Proton User Guide</i>.</p>
|
|
520
|
-
* </note>
|
|
227
|
+
* @see {@link DeleteServiceCommand}
|
|
521
228
|
*/
|
|
522
229
|
deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceCommandOutput>;
|
|
523
230
|
deleteService(args: DeleteServiceCommandInput, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
|
|
524
231
|
deleteService(args: DeleteServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceCommandOutput) => void): void;
|
|
525
232
|
/**
|
|
526
|
-
* @
|
|
527
|
-
* <p>Delete the Proton Ops file.</p>
|
|
233
|
+
* @see {@link DeleteServiceSyncConfigCommand}
|
|
528
234
|
*/
|
|
529
235
|
deleteServiceSyncConfig(args: DeleteServiceSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceSyncConfigCommandOutput>;
|
|
530
236
|
deleteServiceSyncConfig(args: DeleteServiceSyncConfigCommandInput, cb: (err: any, data?: DeleteServiceSyncConfigCommandOutput) => void): void;
|
|
531
237
|
deleteServiceSyncConfig(args: DeleteServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceSyncConfigCommandOutput) => void): void;
|
|
532
238
|
/**
|
|
533
|
-
* @
|
|
534
|
-
* <p>If no other major or minor versions of the service template exist, delete the service
|
|
535
|
-
* template.</p>
|
|
239
|
+
* @see {@link DeleteServiceTemplateCommand}
|
|
536
240
|
*/
|
|
537
241
|
deleteServiceTemplate(args: DeleteServiceTemplateCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceTemplateCommandOutput>;
|
|
538
242
|
deleteServiceTemplate(args: DeleteServiceTemplateCommandInput, cb: (err: any, data?: DeleteServiceTemplateCommandOutput) => void): void;
|
|
539
243
|
deleteServiceTemplate(args: DeleteServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceTemplateCommandOutput) => void): void;
|
|
540
244
|
/**
|
|
541
|
-
* @
|
|
542
|
-
* <p>If no other minor versions of a service template exist, delete a major version of the
|
|
543
|
-
* service template if it's not the <code>Recommended</code> version. Delete the
|
|
544
|
-
* <code>Recommended</code> version of the service template if no other major versions or minor
|
|
545
|
-
* versions of the service template exist. A major version of a service template is a version
|
|
546
|
-
* that <i>isn't</i> backwards compatible.</p>
|
|
547
|
-
* <p>Delete a minor version of a service template if it's not the <code>Recommended</code>
|
|
548
|
-
* version. Delete a <code>Recommended</code> minor version of the service template if no other
|
|
549
|
-
* minor versions of the service template exist. A minor version of a service template is a
|
|
550
|
-
* version that's backwards compatible.</p>
|
|
245
|
+
* @see {@link DeleteServiceTemplateVersionCommand}
|
|
551
246
|
*/
|
|
552
247
|
deleteServiceTemplateVersion(args: DeleteServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceTemplateVersionCommandOutput>;
|
|
553
248
|
deleteServiceTemplateVersion(args: DeleteServiceTemplateVersionCommandInput, cb: (err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void): void;
|
|
554
249
|
deleteServiceTemplateVersion(args: DeleteServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteServiceTemplateVersionCommandOutput) => void): void;
|
|
555
250
|
/**
|
|
556
|
-
* @
|
|
557
|
-
* <p>Delete a template sync configuration.</p>
|
|
251
|
+
* @see {@link DeleteTemplateSyncConfigCommand}
|
|
558
252
|
*/
|
|
559
253
|
deleteTemplateSyncConfig(args: DeleteTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<DeleteTemplateSyncConfigCommandOutput>;
|
|
560
254
|
deleteTemplateSyncConfig(args: DeleteTemplateSyncConfigCommandInput, cb: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void): void;
|
|
561
255
|
deleteTemplateSyncConfig(args: DeleteTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void): void;
|
|
562
256
|
/**
|
|
563
|
-
* @
|
|
564
|
-
* <p>Get detail data for Proton account-wide settings.</p>
|
|
257
|
+
* @see {@link GetAccountSettingsCommand}
|
|
565
258
|
*/
|
|
566
259
|
getAccountSettings(args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountSettingsCommandOutput>;
|
|
567
260
|
getAccountSettings(args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
568
261
|
getAccountSettings(args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
569
262
|
/**
|
|
570
|
-
* @
|
|
571
|
-
* <p>Get detailed data for a component.</p>
|
|
572
|
-
* <p>For more information about components, see
|
|
573
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
574
|
-
* <i>Proton User Guide</i>.</p>
|
|
263
|
+
* @see {@link GetComponentCommand}
|
|
575
264
|
*/
|
|
576
265
|
getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise<GetComponentCommandOutput>;
|
|
577
266
|
getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
|
|
578
267
|
getComponent(args: GetComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
|
|
579
268
|
/**
|
|
580
|
-
* @
|
|
581
|
-
* <p>Get detailed data for an environment.</p>
|
|
269
|
+
* @see {@link GetEnvironmentCommand}
|
|
582
270
|
*/
|
|
583
271
|
getEnvironment(args: GetEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentCommandOutput>;
|
|
584
272
|
getEnvironment(args: GetEnvironmentCommandInput, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
|
|
585
273
|
getEnvironment(args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
|
|
586
274
|
/**
|
|
587
|
-
* @
|
|
588
|
-
* <p>In an environment account, get the detailed data for an environment account connection.</p>
|
|
589
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
590
|
-
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
275
|
+
* @see {@link GetEnvironmentAccountConnectionCommand}
|
|
591
276
|
*/
|
|
592
277
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentAccountConnectionCommandOutput>;
|
|
593
278
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
594
279
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
595
280
|
/**
|
|
596
|
-
* @
|
|
597
|
-
* <p>Get detailed data for an environment template.</p>
|
|
281
|
+
* @see {@link GetEnvironmentTemplateCommand}
|
|
598
282
|
*/
|
|
599
283
|
getEnvironmentTemplate(args: GetEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentTemplateCommandOutput>;
|
|
600
284
|
getEnvironmentTemplate(args: GetEnvironmentTemplateCommandInput, cb: (err: any, data?: GetEnvironmentTemplateCommandOutput) => void): void;
|
|
601
285
|
getEnvironmentTemplate(args: GetEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentTemplateCommandOutput) => void): void;
|
|
602
286
|
/**
|
|
603
|
-
* @
|
|
604
|
-
* <p>Get detailed data for a major or minor version of an environment template.</p>
|
|
287
|
+
* @see {@link GetEnvironmentTemplateVersionCommand}
|
|
605
288
|
*/
|
|
606
289
|
getEnvironmentTemplateVersion(args: GetEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentTemplateVersionCommandOutput>;
|
|
607
290
|
getEnvironmentTemplateVersion(args: GetEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
608
291
|
getEnvironmentTemplateVersion(args: GetEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
609
292
|
/**
|
|
610
|
-
* @
|
|
611
|
-
* <p>Get detail data for a linked repository.</p>
|
|
293
|
+
* @see {@link GetRepositoryCommand}
|
|
612
294
|
*/
|
|
613
295
|
getRepository(args: GetRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositoryCommandOutput>;
|
|
614
296
|
getRepository(args: GetRepositoryCommandInput, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void;
|
|
615
297
|
getRepository(args: GetRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void;
|
|
616
298
|
/**
|
|
617
|
-
* @
|
|
618
|
-
* <p>Get the sync status of a repository used for Proton template sync. For more information about template sync, see .</p>
|
|
619
|
-
* <note>
|
|
620
|
-
* <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
|
|
621
|
-
* have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control
|
|
622
|
-
* (ABAC).</p>
|
|
623
|
-
* <p>For more information about ABAC, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags">ABAC</a> in the <i>Proton User
|
|
624
|
-
* Guide</i>.</p>
|
|
625
|
-
* </note>
|
|
299
|
+
* @see {@link GetRepositorySyncStatusCommand}
|
|
626
300
|
*/
|
|
627
301
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositorySyncStatusCommandOutput>;
|
|
628
302
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void): void;
|
|
629
303
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void): void;
|
|
630
304
|
/**
|
|
631
|
-
* @
|
|
632
|
-
* <p>Get counts of Proton resources.</p>
|
|
633
|
-
* <p>For infrastructure-provisioning resources (environments, services, service instances,
|
|
634
|
-
* pipelines), the action returns staleness counts. A resource is stale when it's behind the
|
|
635
|
-
* recommended version of the Proton template that it uses and it needs an update to become
|
|
636
|
-
* current.</p>
|
|
637
|
-
* <p>The action returns staleness counts (counts of resources that are up-to-date, behind a
|
|
638
|
-
* template major version, or behind a template minor version), the total number of resources, and
|
|
639
|
-
* the number of resources that are in a failed state, grouped by resource type. Components,
|
|
640
|
-
* environments, and service templates return less information - see the <code>components</code>,
|
|
641
|
-
* <code>environments</code>, and <code>serviceTemplates</code> field descriptions.</p>
|
|
642
|
-
* <p>For context, the action also returns the total number of each type of Proton template in the
|
|
643
|
-
* Amazon Web Services account.</p>
|
|
644
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html">Proton dashboard</a> in the
|
|
645
|
-
* <i>Proton User Guide</i>.</p>
|
|
305
|
+
* @see {@link GetResourcesSummaryCommand}
|
|
646
306
|
*/
|
|
647
307
|
getResourcesSummary(args: GetResourcesSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcesSummaryCommandOutput>;
|
|
648
308
|
getResourcesSummary(args: GetResourcesSummaryCommandInput, cb: (err: any, data?: GetResourcesSummaryCommandOutput) => void): void;
|
|
649
309
|
getResourcesSummary(args: GetResourcesSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesSummaryCommandOutput) => void): void;
|
|
650
310
|
/**
|
|
651
|
-
* @
|
|
652
|
-
* <p>Get detailed data for a service.</p>
|
|
311
|
+
* @see {@link GetServiceCommand}
|
|
653
312
|
*/
|
|
654
313
|
getService(args: GetServiceCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceCommandOutput>;
|
|
655
314
|
getService(args: GetServiceCommandInput, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
|
|
656
315
|
getService(args: GetServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceCommandOutput) => void): void;
|
|
657
316
|
/**
|
|
658
|
-
* @
|
|
659
|
-
* <p>Get detailed data for a service instance. A service instance is an instantiation of
|
|
660
|
-
* service template and it runs in a specific environment.</p>
|
|
317
|
+
* @see {@link GetServiceInstanceCommand}
|
|
661
318
|
*/
|
|
662
319
|
getServiceInstance(args: GetServiceInstanceCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceInstanceCommandOutput>;
|
|
663
320
|
getServiceInstance(args: GetServiceInstanceCommandInput, cb: (err: any, data?: GetServiceInstanceCommandOutput) => void): void;
|
|
664
321
|
getServiceInstance(args: GetServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceInstanceCommandOutput) => void): void;
|
|
665
322
|
/**
|
|
666
|
-
* @
|
|
667
|
-
* <p>Get the status of the synced service instance.</p>
|
|
323
|
+
* @see {@link GetServiceInstanceSyncStatusCommand}
|
|
668
324
|
*/
|
|
669
325
|
getServiceInstanceSyncStatus(args: GetServiceInstanceSyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceInstanceSyncStatusCommandOutput>;
|
|
670
326
|
getServiceInstanceSyncStatus(args: GetServiceInstanceSyncStatusCommandInput, cb: (err: any, data?: GetServiceInstanceSyncStatusCommandOutput) => void): void;
|
|
671
327
|
getServiceInstanceSyncStatus(args: GetServiceInstanceSyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceInstanceSyncStatusCommandOutput) => void): void;
|
|
672
328
|
/**
|
|
673
|
-
* @
|
|
674
|
-
* <p>Get detailed data for the service sync blocker summary.</p>
|
|
329
|
+
* @see {@link GetServiceSyncBlockerSummaryCommand}
|
|
675
330
|
*/
|
|
676
331
|
getServiceSyncBlockerSummary(args: GetServiceSyncBlockerSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceSyncBlockerSummaryCommandOutput>;
|
|
677
332
|
getServiceSyncBlockerSummary(args: GetServiceSyncBlockerSummaryCommandInput, cb: (err: any, data?: GetServiceSyncBlockerSummaryCommandOutput) => void): void;
|
|
678
333
|
getServiceSyncBlockerSummary(args: GetServiceSyncBlockerSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSyncBlockerSummaryCommandOutput) => void): void;
|
|
679
334
|
/**
|
|
680
|
-
* @
|
|
681
|
-
* <p>Get detailed information for the service sync configuration.</p>
|
|
335
|
+
* @see {@link GetServiceSyncConfigCommand}
|
|
682
336
|
*/
|
|
683
337
|
getServiceSyncConfig(args: GetServiceSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceSyncConfigCommandOutput>;
|
|
684
338
|
getServiceSyncConfig(args: GetServiceSyncConfigCommandInput, cb: (err: any, data?: GetServiceSyncConfigCommandOutput) => void): void;
|
|
685
339
|
getServiceSyncConfig(args: GetServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceSyncConfigCommandOutput) => void): void;
|
|
686
340
|
/**
|
|
687
|
-
* @
|
|
688
|
-
* <p>Get detailed data for a service template.</p>
|
|
341
|
+
* @see {@link GetServiceTemplateCommand}
|
|
689
342
|
*/
|
|
690
343
|
getServiceTemplate(args: GetServiceTemplateCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceTemplateCommandOutput>;
|
|
691
344
|
getServiceTemplate(args: GetServiceTemplateCommandInput, cb: (err: any, data?: GetServiceTemplateCommandOutput) => void): void;
|
|
692
345
|
getServiceTemplate(args: GetServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceTemplateCommandOutput) => void): void;
|
|
693
346
|
/**
|
|
694
|
-
* @
|
|
695
|
-
* <p>Get detailed data for a major or minor version of a service template.</p>
|
|
347
|
+
* @see {@link GetServiceTemplateVersionCommand}
|
|
696
348
|
*/
|
|
697
349
|
getServiceTemplateVersion(args: GetServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<GetServiceTemplateVersionCommandOutput>;
|
|
698
350
|
getServiceTemplateVersion(args: GetServiceTemplateVersionCommandInput, cb: (err: any, data?: GetServiceTemplateVersionCommandOutput) => void): void;
|
|
699
351
|
getServiceTemplateVersion(args: GetServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetServiceTemplateVersionCommandOutput) => void): void;
|
|
700
352
|
/**
|
|
701
|
-
* @
|
|
702
|
-
* <p>Get detail data for a template sync configuration.</p>
|
|
353
|
+
* @see {@link GetTemplateSyncConfigCommand}
|
|
703
354
|
*/
|
|
704
355
|
getTemplateSyncConfig(args: GetTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetTemplateSyncConfigCommandOutput>;
|
|
705
356
|
getTemplateSyncConfig(args: GetTemplateSyncConfigCommandInput, cb: (err: any, data?: GetTemplateSyncConfigCommandOutput) => void): void;
|
|
706
357
|
getTemplateSyncConfig(args: GetTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateSyncConfigCommandOutput) => void): void;
|
|
707
358
|
/**
|
|
708
|
-
* @
|
|
709
|
-
* <p>Get the status of a template sync.</p>
|
|
359
|
+
* @see {@link GetTemplateSyncStatusCommand}
|
|
710
360
|
*/
|
|
711
361
|
getTemplateSyncStatus(args: GetTemplateSyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetTemplateSyncStatusCommandOutput>;
|
|
712
362
|
getTemplateSyncStatus(args: GetTemplateSyncStatusCommandInput, cb: (err: any, data?: GetTemplateSyncStatusCommandOutput) => void): void;
|
|
713
363
|
getTemplateSyncStatus(args: GetTemplateSyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateSyncStatusCommandOutput) => void): void;
|
|
714
364
|
/**
|
|
715
|
-
* @
|
|
716
|
-
* <p>Get a list of component Infrastructure as Code (IaC) outputs.</p>
|
|
717
|
-
* <p>For more information about components, see
|
|
718
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
719
|
-
* <i>Proton User Guide</i>.</p>
|
|
365
|
+
* @see {@link ListComponentOutputsCommand}
|
|
720
366
|
*/
|
|
721
367
|
listComponentOutputs(args: ListComponentOutputsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentOutputsCommandOutput>;
|
|
722
368
|
listComponentOutputs(args: ListComponentOutputsCommandInput, cb: (err: any, data?: ListComponentOutputsCommandOutput) => void): void;
|
|
723
369
|
listComponentOutputs(args: ListComponentOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentOutputsCommandOutput) => void): void;
|
|
724
370
|
/**
|
|
725
|
-
* @
|
|
726
|
-
* <p>List provisioned resources for a component with details.</p>
|
|
727
|
-
* <p>For more information about components, see
|
|
728
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
729
|
-
* <i>Proton User Guide</i>.</p>
|
|
371
|
+
* @see {@link ListComponentProvisionedResourcesCommand}
|
|
730
372
|
*/
|
|
731
373
|
listComponentProvisionedResources(args: ListComponentProvisionedResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentProvisionedResourcesCommandOutput>;
|
|
732
374
|
listComponentProvisionedResources(args: ListComponentProvisionedResourcesCommandInput, cb: (err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void): void;
|
|
733
375
|
listComponentProvisionedResources(args: ListComponentProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void): void;
|
|
734
376
|
/**
|
|
735
|
-
* @
|
|
736
|
-
* <p>List components with summary data. You can filter the result list by environment, service, or a single service instance.</p>
|
|
737
|
-
* <p>For more information about components, see
|
|
738
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
739
|
-
* <i>Proton User Guide</i>.</p>
|
|
377
|
+
* @see {@link ListComponentsCommand}
|
|
740
378
|
*/
|
|
741
379
|
listComponents(args: ListComponentsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentsCommandOutput>;
|
|
742
380
|
listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
|
|
743
381
|
listComponents(args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
|
|
744
382
|
/**
|
|
745
|
-
* @
|
|
746
|
-
* <p>View a list of environment account connections.</p>
|
|
747
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
748
|
-
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
383
|
+
* @see {@link ListEnvironmentAccountConnectionsCommand}
|
|
749
384
|
*/
|
|
750
385
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentAccountConnectionsCommandOutput>;
|
|
751
386
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, cb: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void): void;
|
|
752
387
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void): void;
|
|
753
388
|
/**
|
|
754
|
-
* @
|
|
755
|
-
* <p>List the infrastructure as code outputs for your environment.</p>
|
|
389
|
+
* @see {@link ListEnvironmentOutputsCommand}
|
|
756
390
|
*/
|
|
757
391
|
listEnvironmentOutputs(args: ListEnvironmentOutputsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentOutputsCommandOutput>;
|
|
758
392
|
listEnvironmentOutputs(args: ListEnvironmentOutputsCommandInput, cb: (err: any, data?: ListEnvironmentOutputsCommandOutput) => void): void;
|
|
759
393
|
listEnvironmentOutputs(args: ListEnvironmentOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentOutputsCommandOutput) => void): void;
|
|
760
394
|
/**
|
|
761
|
-
* @
|
|
762
|
-
* <p>List the provisioned resources for your environment.</p>
|
|
395
|
+
* @see {@link ListEnvironmentProvisionedResourcesCommand}
|
|
763
396
|
*/
|
|
764
397
|
listEnvironmentProvisionedResources(args: ListEnvironmentProvisionedResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentProvisionedResourcesCommandOutput>;
|
|
765
398
|
listEnvironmentProvisionedResources(args: ListEnvironmentProvisionedResourcesCommandInput, cb: (err: any, data?: ListEnvironmentProvisionedResourcesCommandOutput) => void): void;
|
|
766
399
|
listEnvironmentProvisionedResources(args: ListEnvironmentProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentProvisionedResourcesCommandOutput) => void): void;
|
|
767
400
|
/**
|
|
768
|
-
* @
|
|
769
|
-
* <p>List environments with detail data summaries.</p>
|
|
401
|
+
* @see {@link ListEnvironmentsCommand}
|
|
770
402
|
*/
|
|
771
403
|
listEnvironments(args: ListEnvironmentsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentsCommandOutput>;
|
|
772
404
|
listEnvironments(args: ListEnvironmentsCommandInput, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
|
|
773
405
|
listEnvironments(args: ListEnvironmentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentsCommandOutput) => void): void;
|
|
774
406
|
/**
|
|
775
|
-
* @
|
|
776
|
-
* <p>List environment templates.</p>
|
|
407
|
+
* @see {@link ListEnvironmentTemplatesCommand}
|
|
777
408
|
*/
|
|
778
409
|
listEnvironmentTemplates(args: ListEnvironmentTemplatesCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentTemplatesCommandOutput>;
|
|
779
410
|
listEnvironmentTemplates(args: ListEnvironmentTemplatesCommandInput, cb: (err: any, data?: ListEnvironmentTemplatesCommandOutput) => void): void;
|
|
780
411
|
listEnvironmentTemplates(args: ListEnvironmentTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentTemplatesCommandOutput) => void): void;
|
|
781
412
|
/**
|
|
782
|
-
* @
|
|
783
|
-
* <p>List major or minor versions of an environment template with detail data.</p>
|
|
413
|
+
* @see {@link ListEnvironmentTemplateVersionsCommand}
|
|
784
414
|
*/
|
|
785
415
|
listEnvironmentTemplateVersions(args: ListEnvironmentTemplateVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentTemplateVersionsCommandOutput>;
|
|
786
416
|
listEnvironmentTemplateVersions(args: ListEnvironmentTemplateVersionsCommandInput, cb: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void): void;
|
|
787
417
|
listEnvironmentTemplateVersions(args: ListEnvironmentTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void): void;
|
|
788
418
|
/**
|
|
789
|
-
* @
|
|
790
|
-
* <p>List linked repositories with detail data.</p>
|
|
419
|
+
* @see {@link ListRepositoriesCommand}
|
|
791
420
|
*/
|
|
792
421
|
listRepositories(args: ListRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListRepositoriesCommandOutput>;
|
|
793
422
|
listRepositories(args: ListRepositoriesCommandInput, cb: (err: any, data?: ListRepositoriesCommandOutput) => void): void;
|
|
794
423
|
listRepositories(args: ListRepositoriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositoriesCommandOutput) => void): void;
|
|
795
424
|
/**
|
|
796
|
-
* @
|
|
797
|
-
* <p>List repository sync definitions with detail data.</p>
|
|
425
|
+
* @see {@link ListRepositorySyncDefinitionsCommand}
|
|
798
426
|
*/
|
|
799
427
|
listRepositorySyncDefinitions(args: ListRepositorySyncDefinitionsCommandInput, options?: __HttpHandlerOptions): Promise<ListRepositorySyncDefinitionsCommandOutput>;
|
|
800
428
|
listRepositorySyncDefinitions(args: ListRepositorySyncDefinitionsCommandInput, cb: (err: any, data?: ListRepositorySyncDefinitionsCommandOutput) => void): void;
|
|
801
429
|
listRepositorySyncDefinitions(args: ListRepositorySyncDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRepositorySyncDefinitionsCommandOutput) => void): void;
|
|
802
430
|
/**
|
|
803
|
-
* @
|
|
804
|
-
* <p>Get a list service of instance Infrastructure as Code (IaC) outputs.</p>
|
|
431
|
+
* @see {@link ListServiceInstanceOutputsCommand}
|
|
805
432
|
*/
|
|
806
433
|
listServiceInstanceOutputs(args: ListServiceInstanceOutputsCommandInput, options?: __HttpHandlerOptions): Promise<ListServiceInstanceOutputsCommandOutput>;
|
|
807
434
|
listServiceInstanceOutputs(args: ListServiceInstanceOutputsCommandInput, cb: (err: any, data?: ListServiceInstanceOutputsCommandOutput) => void): void;
|
|
808
435
|
listServiceInstanceOutputs(args: ListServiceInstanceOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstanceOutputsCommandOutput) => void): void;
|
|
809
436
|
/**
|
|
810
|
-
* @
|
|
811
|
-
* <p>List provisioned resources for a service instance with details.</p>
|
|
437
|
+
* @see {@link ListServiceInstanceProvisionedResourcesCommand}
|
|
812
438
|
*/
|
|
813
439
|
listServiceInstanceProvisionedResources(args: ListServiceInstanceProvisionedResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListServiceInstanceProvisionedResourcesCommandOutput>;
|
|
814
440
|
listServiceInstanceProvisionedResources(args: ListServiceInstanceProvisionedResourcesCommandInput, cb: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void): void;
|
|
815
441
|
listServiceInstanceProvisionedResources(args: ListServiceInstanceProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void): void;
|
|
816
442
|
/**
|
|
817
|
-
* @
|
|
818
|
-
* <p>List service instances with summary data. This action lists service instances of all
|
|
819
|
-
* services in the Amazon Web Services account.</p>
|
|
443
|
+
* @see {@link ListServiceInstancesCommand}
|
|
820
444
|
*/
|
|
821
445
|
listServiceInstances(args: ListServiceInstancesCommandInput, options?: __HttpHandlerOptions): Promise<ListServiceInstancesCommandOutput>;
|
|
822
446
|
listServiceInstances(args: ListServiceInstancesCommandInput, cb: (err: any, data?: ListServiceInstancesCommandOutput) => void): void;
|
|
823
447
|
listServiceInstances(args: ListServiceInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstancesCommandOutput) => void): void;
|
|
824
448
|
/**
|
|
825
|
-
* @
|
|
826
|
-
* <p>Get a list of service pipeline Infrastructure as Code (IaC) outputs.</p>
|
|
449
|
+
* @see {@link ListServicePipelineOutputsCommand}
|
|
827
450
|
*/
|
|
828
451
|
listServicePipelineOutputs(args: ListServicePipelineOutputsCommandInput, options?: __HttpHandlerOptions): Promise<ListServicePipelineOutputsCommandOutput>;
|
|
829
452
|
listServicePipelineOutputs(args: ListServicePipelineOutputsCommandInput, cb: (err: any, data?: ListServicePipelineOutputsCommandOutput) => void): void;
|
|
830
453
|
listServicePipelineOutputs(args: ListServicePipelineOutputsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicePipelineOutputsCommandOutput) => void): void;
|
|
831
454
|
/**
|
|
832
|
-
* @
|
|
833
|
-
* <p>List provisioned resources for a service and pipeline with details.</p>
|
|
455
|
+
* @see {@link ListServicePipelineProvisionedResourcesCommand}
|
|
834
456
|
*/
|
|
835
457
|
listServicePipelineProvisionedResources(args: ListServicePipelineProvisionedResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListServicePipelineProvisionedResourcesCommandOutput>;
|
|
836
458
|
listServicePipelineProvisionedResources(args: ListServicePipelineProvisionedResourcesCommandInput, cb: (err: any, data?: ListServicePipelineProvisionedResourcesCommandOutput) => void): void;
|
|
837
459
|
listServicePipelineProvisionedResources(args: ListServicePipelineProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicePipelineProvisionedResourcesCommandOutput) => void): void;
|
|
838
460
|
/**
|
|
839
|
-
* @
|
|
840
|
-
* <p>List services with summaries of detail data.</p>
|
|
461
|
+
* @see {@link ListServicesCommand}
|
|
841
462
|
*/
|
|
842
463
|
listServices(args: ListServicesCommandInput, options?: __HttpHandlerOptions): Promise<ListServicesCommandOutput>;
|
|
843
464
|
listServices(args: ListServicesCommandInput, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
844
465
|
listServices(args: ListServicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServicesCommandOutput) => void): void;
|
|
845
466
|
/**
|
|
846
|
-
* @
|
|
847
|
-
* <p>List service templates with detail data.</p>
|
|
467
|
+
* @see {@link ListServiceTemplatesCommand}
|
|
848
468
|
*/
|
|
849
469
|
listServiceTemplates(args: ListServiceTemplatesCommandInput, options?: __HttpHandlerOptions): Promise<ListServiceTemplatesCommandOutput>;
|
|
850
470
|
listServiceTemplates(args: ListServiceTemplatesCommandInput, cb: (err: any, data?: ListServiceTemplatesCommandOutput) => void): void;
|
|
851
471
|
listServiceTemplates(args: ListServiceTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceTemplatesCommandOutput) => void): void;
|
|
852
472
|
/**
|
|
853
|
-
* @
|
|
854
|
-
* <p>List major or minor versions of a service template with detail data.</p>
|
|
473
|
+
* @see {@link ListServiceTemplateVersionsCommand}
|
|
855
474
|
*/
|
|
856
475
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListServiceTemplateVersionsCommandOutput>;
|
|
857
476
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void): void;
|
|
858
477
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void): void;
|
|
859
478
|
/**
|
|
860
|
-
* @
|
|
861
|
-
* <p>List tags for a resource. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
862
|
-
* <i>Proton User Guide</i>.</p>
|
|
479
|
+
* @see {@link ListTagsForResourceCommand}
|
|
863
480
|
*/
|
|
864
481
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
865
482
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
866
483
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
867
484
|
/**
|
|
868
|
-
* @
|
|
869
|
-
* <p>Notify Proton of status changes to a provisioned resource when you use self-managed
|
|
870
|
-
* provisioning.</p>
|
|
871
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed
|
|
872
|
-
* provisioning</a> in the <i>Proton User Guide</i>.</p>
|
|
485
|
+
* @see {@link NotifyResourceDeploymentStatusChangeCommand}
|
|
873
486
|
*/
|
|
874
487
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, options?: __HttpHandlerOptions): Promise<NotifyResourceDeploymentStatusChangeCommandOutput>;
|
|
875
488
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void): void;
|
|
876
489
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void): void;
|
|
877
490
|
/**
|
|
878
|
-
* @
|
|
879
|
-
* <p>In a management account, reject an environment account connection from another environment account.</p>
|
|
880
|
-
* <p>After you reject an environment account connection request, you <i>can't</i> accept or use the rejected environment account
|
|
881
|
-
* connection.</p>
|
|
882
|
-
* <p>You <i>can’t</i> reject an environment account connection that's connected to an environment.</p>
|
|
883
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
884
|
-
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
491
|
+
* @see {@link RejectEnvironmentAccountConnectionCommand}
|
|
885
492
|
*/
|
|
886
493
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<RejectEnvironmentAccountConnectionCommandOutput>;
|
|
887
494
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
888
495
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
889
496
|
/**
|
|
890
|
-
* @
|
|
891
|
-
* <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton
|
|
892
|
-
* resource.</p>
|
|
893
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
894
|
-
* <i>Proton User Guide</i>.</p>
|
|
497
|
+
* @see {@link TagResourceCommand}
|
|
895
498
|
*/
|
|
896
499
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
897
500
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
898
501
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
899
502
|
/**
|
|
900
|
-
* @
|
|
901
|
-
* <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with
|
|
902
|
-
* an Proton resource.</p>
|
|
903
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
904
|
-
* <i>Proton User Guide</i>.</p>
|
|
503
|
+
* @see {@link UntagResourceCommand}
|
|
905
504
|
*/
|
|
906
505
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
907
506
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
908
507
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
909
508
|
/**
|
|
910
|
-
* @
|
|
911
|
-
* <p>Update Proton settings that are used for multiple services in the Amazon Web Services account.</p>
|
|
509
|
+
* @see {@link UpdateAccountSettingsCommand}
|
|
912
510
|
*/
|
|
913
511
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountSettingsCommandOutput>;
|
|
914
512
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
915
513
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
916
514
|
/**
|
|
917
|
-
* @
|
|
918
|
-
* <p>Update a component.</p>
|
|
919
|
-
* <p>There are a few modes for updating a component. The <code>deploymentType</code> field defines the mode.</p>
|
|
920
|
-
* <note>
|
|
921
|
-
* <p>You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is
|
|
922
|
-
* <code>IN_PROGRESS</code>.</p>
|
|
923
|
-
* </note>
|
|
924
|
-
* <p>For more information about components, see
|
|
925
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
926
|
-
* <i>Proton User Guide</i>.</p>
|
|
515
|
+
* @see {@link UpdateComponentCommand}
|
|
927
516
|
*/
|
|
928
517
|
updateComponent(args: UpdateComponentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateComponentCommandOutput>;
|
|
929
518
|
updateComponent(args: UpdateComponentCommandInput, cb: (err: any, data?: UpdateComponentCommandOutput) => void): void;
|
|
930
519
|
updateComponent(args: UpdateComponentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateComponentCommandOutput) => void): void;
|
|
931
520
|
/**
|
|
932
|
-
* @
|
|
933
|
-
* <p>Update an environment.</p>
|
|
934
|
-
* <p>If the environment is associated with an environment account connection, <i>don't</i> update or include the
|
|
935
|
-
* <code>protonServiceRoleArn</code> and <code>provisioningRepository</code> parameter to update or connect to an environment account connection.</p>
|
|
936
|
-
* <p>You can only update to a new environment account connection if that connection was created in the same environment account that the current
|
|
937
|
-
* environment account connection was created in. The account connection must also be associated with the current environment.</p>
|
|
938
|
-
* <p>If the environment <i>isn't</i> associated with an environment account connection, <i>don't</i> update or include the
|
|
939
|
-
* <code>environmentAccountConnectionId</code> parameter. You <i>can't</i> update or connect the environment to an environment account
|
|
940
|
-
* connection if it <i>isn't</i> already associated with an environment connection.</p>
|
|
941
|
-
* <p>You can update either the <code>environmentAccountConnectionId</code> or <code>protonServiceRoleArn</code> parameter and value. You can’t update
|
|
942
|
-
* both.</p>
|
|
943
|
-
* <p>If the environment was configured for Amazon Web Services-managed provisioning, omit the <code>provisioningRepository</code> parameter.</p>
|
|
944
|
-
* <p>If the environment was configured for self-managed provisioning, specify the <code>provisioningRepository</code> parameter and omit the
|
|
945
|
-
* <code>protonServiceRoleArn</code> and <code>environmentAccountConnectionId</code> parameters.</p>
|
|
946
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton User
|
|
947
|
-
* Guide</i>.</p>
|
|
948
|
-
* <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
|
|
949
|
-
* <dl>
|
|
950
|
-
* <dt/>
|
|
951
|
-
* <dd>
|
|
952
|
-
* <p>
|
|
953
|
-
* <code>NONE</code>
|
|
954
|
-
* </p>
|
|
955
|
-
* <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested metadata parameters are updated.</p>
|
|
956
|
-
* </dd>
|
|
957
|
-
* <dt/>
|
|
958
|
-
* <dd>
|
|
959
|
-
* <p>
|
|
960
|
-
* <code>CURRENT_VERSION</code>
|
|
961
|
-
* </p>
|
|
962
|
-
* <p>In this mode, the environment is deployed and updated with the new spec that you provide. Only requested parameters are updated.
|
|
963
|
-
* <i>Don’t</i> include minor or major version parameters when you use this <code>deployment-type</code>.</p>
|
|
964
|
-
* </dd>
|
|
965
|
-
* <dt/>
|
|
966
|
-
* <dd>
|
|
967
|
-
* <p>
|
|
968
|
-
* <code>MINOR_VERSION</code>
|
|
969
|
-
* </p>
|
|
970
|
-
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) minor version of the current major version in
|
|
971
|
-
* use, by default. You can also specify a different minor version of the current major version in use.</p>
|
|
972
|
-
* </dd>
|
|
973
|
-
* <dt/>
|
|
974
|
-
* <dd>
|
|
975
|
-
* <p>
|
|
976
|
-
* <code>MAJOR_VERSION</code>
|
|
977
|
-
* </p>
|
|
978
|
-
* <p>In this mode, the environment is deployed and updated with the published, recommended (latest) major and minor version of the current template,
|
|
979
|
-
* by default. You can also specify a different major version that's higher than the major version in use and a minor version.</p>
|
|
980
|
-
* </dd>
|
|
981
|
-
* </dl>
|
|
521
|
+
* @see {@link UpdateEnvironmentCommand}
|
|
982
522
|
*/
|
|
983
523
|
updateEnvironment(args: UpdateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentCommandOutput>;
|
|
984
524
|
updateEnvironment(args: UpdateEnvironmentCommandInput, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void): void;
|
|
985
525
|
updateEnvironment(args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void): void;
|
|
986
526
|
/**
|
|
987
|
-
* @
|
|
988
|
-
* <p>In an environment account, update an environment account connection to use a new IAM role.</p>
|
|
989
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
990
|
-
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
527
|
+
* @see {@link UpdateEnvironmentAccountConnectionCommand}
|
|
991
528
|
*/
|
|
992
529
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentAccountConnectionCommandOutput>;
|
|
993
530
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
994
531
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
995
532
|
/**
|
|
996
|
-
* @
|
|
997
|
-
* <p>Update an environment template.</p>
|
|
533
|
+
* @see {@link UpdateEnvironmentTemplateCommand}
|
|
998
534
|
*/
|
|
999
535
|
updateEnvironmentTemplate(args: UpdateEnvironmentTemplateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentTemplateCommandOutput>;
|
|
1000
536
|
updateEnvironmentTemplate(args: UpdateEnvironmentTemplateCommandInput, cb: (err: any, data?: UpdateEnvironmentTemplateCommandOutput) => void): void;
|
|
1001
537
|
updateEnvironmentTemplate(args: UpdateEnvironmentTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentTemplateCommandOutput) => void): void;
|
|
1002
538
|
/**
|
|
1003
|
-
* @
|
|
1004
|
-
* <p>Update a major or minor version of an environment template.</p>
|
|
539
|
+
* @see {@link UpdateEnvironmentTemplateVersionCommand}
|
|
1005
540
|
*/
|
|
1006
541
|
updateEnvironmentTemplateVersion(args: UpdateEnvironmentTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentTemplateVersionCommandOutput>;
|
|
1007
542
|
updateEnvironmentTemplateVersion(args: UpdateEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: UpdateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
1008
543
|
updateEnvironmentTemplateVersion(args: UpdateEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
1009
544
|
/**
|
|
1010
|
-
* @
|
|
1011
|
-
* <p>Edit a service description or use a spec to add and delete service instances.</p>
|
|
1012
|
-
* <note>
|
|
1013
|
-
* <p>Existing service instances and the service pipeline <i>can't</i> be edited
|
|
1014
|
-
* using this API. They can only be deleted.</p>
|
|
1015
|
-
* </note>
|
|
1016
|
-
* <p>Use the <code>description</code> parameter to modify the description.</p>
|
|
1017
|
-
* <p>Edit the <code>spec</code> parameter to add or delete instances.</p>
|
|
1018
|
-
* <note>
|
|
1019
|
-
* <p>You can't delete a service instance (remove it from the spec) if it has an attached
|
|
1020
|
-
* component.</p>
|
|
1021
|
-
* <p>For more information about components, see
|
|
1022
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
1023
|
-
* <i>Proton User Guide</i>.</p>
|
|
1024
|
-
* </note>
|
|
545
|
+
* @see {@link UpdateServiceCommand}
|
|
1025
546
|
*/
|
|
1026
547
|
updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceCommandOutput>;
|
|
1027
548
|
updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
|
|
1028
549
|
updateService(args: UpdateServiceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
|
|
1029
550
|
/**
|
|
1030
|
-
* @
|
|
1031
|
-
* <p>Update a service instance.</p>
|
|
1032
|
-
* <p>There are a few modes for updating a service instance. The <code>deploymentType</code>
|
|
1033
|
-
* field defines the mode.</p>
|
|
1034
|
-
* <note>
|
|
1035
|
-
* <p>You can't update a service instance while its deployment status, or the deployment
|
|
1036
|
-
* status of a component attached to it, is <code>IN_PROGRESS</code>.</p>
|
|
1037
|
-
* <p>For more information about components, see
|
|
1038
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
1039
|
-
* <i>Proton User Guide</i>.</p>
|
|
1040
|
-
* </note>
|
|
551
|
+
* @see {@link UpdateServiceInstanceCommand}
|
|
1041
552
|
*/
|
|
1042
553
|
updateServiceInstance(args: UpdateServiceInstanceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceInstanceCommandOutput>;
|
|
1043
554
|
updateServiceInstance(args: UpdateServiceInstanceCommandInput, cb: (err: any, data?: UpdateServiceInstanceCommandOutput) => void): void;
|
|
1044
555
|
updateServiceInstance(args: UpdateServiceInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceInstanceCommandOutput) => void): void;
|
|
1045
556
|
/**
|
|
1046
|
-
* @
|
|
1047
|
-
* <p>Update the service pipeline.</p>
|
|
1048
|
-
* <p>There are four modes for updating a service pipeline. The <code>deploymentType</code>
|
|
1049
|
-
* field defines the mode.</p>
|
|
1050
|
-
* <dl>
|
|
1051
|
-
* <dt/>
|
|
1052
|
-
* <dd>
|
|
1053
|
-
* <p>
|
|
1054
|
-
* <code>NONE</code>
|
|
1055
|
-
* </p>
|
|
1056
|
-
* <p>In this mode, a deployment <i>doesn't</i> occur. Only the requested
|
|
1057
|
-
* metadata parameters are updated.</p>
|
|
1058
|
-
* </dd>
|
|
1059
|
-
* <dt/>
|
|
1060
|
-
* <dd>
|
|
1061
|
-
* <p>
|
|
1062
|
-
* <code>CURRENT_VERSION</code>
|
|
1063
|
-
* </p>
|
|
1064
|
-
* <p>In this mode, the service pipeline is deployed and updated with the new spec that
|
|
1065
|
-
* you provide. Only requested parameters are updated. <i>Don’t</i> include
|
|
1066
|
-
* major or minor version parameters when you use this <code>deployment-type</code>.</p>
|
|
1067
|
-
* </dd>
|
|
1068
|
-
* <dt/>
|
|
1069
|
-
* <dd>
|
|
1070
|
-
* <p>
|
|
1071
|
-
* <code>MINOR_VERSION</code>
|
|
1072
|
-
* </p>
|
|
1073
|
-
* <p>In this mode, the service pipeline is deployed and updated with the published,
|
|
1074
|
-
* recommended (latest) minor version of the current major version in use, by default. You
|
|
1075
|
-
* can specify a different minor version of the current major version in use.</p>
|
|
1076
|
-
* </dd>
|
|
1077
|
-
* <dt/>
|
|
1078
|
-
* <dd>
|
|
1079
|
-
* <p>
|
|
1080
|
-
* <code>MAJOR_VERSION</code>
|
|
1081
|
-
* </p>
|
|
1082
|
-
* <p>In this mode, the service pipeline is deployed and updated with the published,
|
|
1083
|
-
* recommended (latest) major and minor version of the current template by default. You can
|
|
1084
|
-
* specify a different major version that's higher than the major version in use and a
|
|
1085
|
-
* minor version.</p>
|
|
1086
|
-
* </dd>
|
|
1087
|
-
* </dl>
|
|
557
|
+
* @see {@link UpdateServicePipelineCommand}
|
|
1088
558
|
*/
|
|
1089
559
|
updateServicePipeline(args: UpdateServicePipelineCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServicePipelineCommandOutput>;
|
|
1090
560
|
updateServicePipeline(args: UpdateServicePipelineCommandInput, cb: (err: any, data?: UpdateServicePipelineCommandOutput) => void): void;
|
|
1091
561
|
updateServicePipeline(args: UpdateServicePipelineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServicePipelineCommandOutput) => void): void;
|
|
1092
562
|
/**
|
|
1093
|
-
* @
|
|
1094
|
-
* <p>Update the service sync blocker by resolving it.</p>
|
|
563
|
+
* @see {@link UpdateServiceSyncBlockerCommand}
|
|
1095
564
|
*/
|
|
1096
565
|
updateServiceSyncBlocker(args: UpdateServiceSyncBlockerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceSyncBlockerCommandOutput>;
|
|
1097
566
|
updateServiceSyncBlocker(args: UpdateServiceSyncBlockerCommandInput, cb: (err: any, data?: UpdateServiceSyncBlockerCommandOutput) => void): void;
|
|
1098
567
|
updateServiceSyncBlocker(args: UpdateServiceSyncBlockerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSyncBlockerCommandOutput) => void): void;
|
|
1099
568
|
/**
|
|
1100
|
-
* @
|
|
1101
|
-
* <p>Update the Proton Ops config file.</p>
|
|
569
|
+
* @see {@link UpdateServiceSyncConfigCommand}
|
|
1102
570
|
*/
|
|
1103
571
|
updateServiceSyncConfig(args: UpdateServiceSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceSyncConfigCommandOutput>;
|
|
1104
572
|
updateServiceSyncConfig(args: UpdateServiceSyncConfigCommandInput, cb: (err: any, data?: UpdateServiceSyncConfigCommandOutput) => void): void;
|
|
1105
573
|
updateServiceSyncConfig(args: UpdateServiceSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceSyncConfigCommandOutput) => void): void;
|
|
1106
574
|
/**
|
|
1107
|
-
* @
|
|
1108
|
-
* <p>Update a service template.</p>
|
|
575
|
+
* @see {@link UpdateServiceTemplateCommand}
|
|
1109
576
|
*/
|
|
1110
577
|
updateServiceTemplate(args: UpdateServiceTemplateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceTemplateCommandOutput>;
|
|
1111
578
|
updateServiceTemplate(args: UpdateServiceTemplateCommandInput, cb: (err: any, data?: UpdateServiceTemplateCommandOutput) => void): void;
|
|
1112
579
|
updateServiceTemplate(args: UpdateServiceTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceTemplateCommandOutput) => void): void;
|
|
1113
580
|
/**
|
|
1114
|
-
* @
|
|
1115
|
-
* <p>Update a major or minor version of a service template.</p>
|
|
581
|
+
* @see {@link UpdateServiceTemplateVersionCommand}
|
|
1116
582
|
*/
|
|
1117
583
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceTemplateVersionCommandOutput>;
|
|
1118
584
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void): void;
|
|
1119
585
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void): void;
|
|
1120
586
|
/**
|
|
1121
|
-
* @
|
|
1122
|
-
* <p>Update template sync configuration parameters, except for the <code>templateName</code> and
|
|
1123
|
-
* <code>templateType</code>. Repository details (branch, name, and provider) should be of a linked
|
|
1124
|
-
* repository. A linked repository is a repository that has been registered with Proton. For more
|
|
1125
|
-
* information, see <a>CreateRepository</a>.</p>
|
|
587
|
+
* @see {@link UpdateTemplateSyncConfigCommand}
|
|
1126
588
|
*/
|
|
1127
589
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTemplateSyncConfigCommandOutput>;
|
|
1128
590
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, cb: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void): void;
|
|
1129
591
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void): void;
|
|
1130
592
|
}
|
|
593
|
+
/**
|
|
594
|
+
* @public
|
|
595
|
+
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
596
|
+
* <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
|
|
597
|
+
* service.</p>
|
|
598
|
+
* <p>The documentation for each action shows the Query API request parameters and the XML response.</p>
|
|
599
|
+
* <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
|
|
600
|
+
* Guide</a>.</p>
|
|
601
|
+
* <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide
|
|
602
|
+
* standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in
|
|
603
|
+
* turn, select from the available service templates to automate their application or service deployments.</p>
|
|
604
|
+
* <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need
|
|
605
|
+
* permissions to use all of the listed API operations.</p>
|
|
606
|
+
* <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To
|
|
607
|
+
* monitor their applications that are running on Proton, developers need permissions to the service
|
|
608
|
+
* <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i>
|
|
609
|
+
* API operations and the service instance <i>list</i> and <i>update</i> API
|
|
610
|
+
* operations.</p>
|
|
611
|
+
* <p>To learn more about Proton, see the <a href="https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html">Proton User Guide</a>.</p>
|
|
612
|
+
* <p>
|
|
613
|
+
* <b>Ensuring Idempotency</b>
|
|
614
|
+
* </p>
|
|
615
|
+
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
616
|
+
* of the operation are complete. Operations might also time out or encounter other server issues before they're
|
|
617
|
+
* complete, even if the request already returned a result. This might make it difficult to determine whether the
|
|
618
|
+
* request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation
|
|
619
|
+
* completes successfully. However, if the original request and the subsequent retries are successful, the operation
|
|
620
|
+
* occurs multiple times. This means that you might create more resources than you intended.</p>
|
|
621
|
+
* <p>
|
|
622
|
+
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
623
|
+
* idempotent request, if the original request action completes successfully, any subsequent retries complete
|
|
624
|
+
* successfully without performing any further actions. However, the result might contain updated information, such as
|
|
625
|
+
* the current creation status.</p>
|
|
626
|
+
* <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
|
|
627
|
+
* <p>
|
|
628
|
+
* <b>Idempotent create APIs with a client token</b>
|
|
629
|
+
* </p>
|
|
630
|
+
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
631
|
+
* corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,
|
|
632
|
+
* case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,
|
|
633
|
+
* specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token
|
|
634
|
+
* for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically
|
|
635
|
+
* provided by SDKs.</p>
|
|
636
|
+
* <p>Given a request action that has succeeded:</p>
|
|
637
|
+
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
638
|
+
* performing any further actions other than returning the original resource detail data in the response.</p>
|
|
639
|
+
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
640
|
+
* throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
|
|
641
|
+
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
642
|
+
* resource is created.</p>
|
|
643
|
+
* <p>If the original resource is deleted and you retry the request, a new resource is created.</p>
|
|
644
|
+
* <p>Idempotent create APIs with a client token:</p>
|
|
645
|
+
* <ul>
|
|
646
|
+
* <li>
|
|
647
|
+
* <p>CreateEnvironmentTemplateVersion</p>
|
|
648
|
+
* </li>
|
|
649
|
+
* <li>
|
|
650
|
+
* <p>CreateServiceTemplateVersion</p>
|
|
651
|
+
* </li>
|
|
652
|
+
* <li>
|
|
653
|
+
* <p>CreateEnvironmentAccountConnection</p>
|
|
654
|
+
* </li>
|
|
655
|
+
* </ul>
|
|
656
|
+
* <p>
|
|
657
|
+
* <b>Idempotent create APIs</b>
|
|
658
|
+
* </p>
|
|
659
|
+
* <p>Given a request action that has succeeded:</p>
|
|
660
|
+
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
661
|
+
* modified, the retry succeeds without performing any further actions other than returning the original resource detail
|
|
662
|
+
* data in the response.</p>
|
|
663
|
+
* <p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
|
|
664
|
+
* <p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
|
|
665
|
+
* <code>IdempotentParameterMismatch</code> error.</p>
|
|
666
|
+
* <p>Idempotent create APIs:</p>
|
|
667
|
+
* <ul>
|
|
668
|
+
* <li>
|
|
669
|
+
* <p>CreateEnvironmentTemplate</p>
|
|
670
|
+
* </li>
|
|
671
|
+
* <li>
|
|
672
|
+
* <p>CreateServiceTemplate</p>
|
|
673
|
+
* </li>
|
|
674
|
+
* <li>
|
|
675
|
+
* <p>CreateEnvironment</p>
|
|
676
|
+
* </li>
|
|
677
|
+
* <li>
|
|
678
|
+
* <p>CreateService</p>
|
|
679
|
+
* </li>
|
|
680
|
+
* </ul>
|
|
681
|
+
* <p>
|
|
682
|
+
* <b>Idempotent delete APIs</b>
|
|
683
|
+
* </p>
|
|
684
|
+
* <p>Given a request action that has succeeded:</p>
|
|
685
|
+
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
686
|
+
* the response.</p>
|
|
687
|
+
* <p>If you retry and the resource doesn't exist, the response is empty.</p>
|
|
688
|
+
* <p>In both cases, the retry succeeds.</p>
|
|
689
|
+
* <p>Idempotent delete APIs:</p>
|
|
690
|
+
* <ul>
|
|
691
|
+
* <li>
|
|
692
|
+
* <p>DeleteEnvironmentTemplate</p>
|
|
693
|
+
* </li>
|
|
694
|
+
* <li>
|
|
695
|
+
* <p>DeleteEnvironmentTemplateVersion</p>
|
|
696
|
+
* </li>
|
|
697
|
+
* <li>
|
|
698
|
+
* <p>DeleteServiceTemplate</p>
|
|
699
|
+
* </li>
|
|
700
|
+
* <li>
|
|
701
|
+
* <p>DeleteServiceTemplateVersion</p>
|
|
702
|
+
* </li>
|
|
703
|
+
* <li>
|
|
704
|
+
* <p>DeleteEnvironmentAccountConnection</p>
|
|
705
|
+
* </li>
|
|
706
|
+
* </ul>
|
|
707
|
+
* <p>
|
|
708
|
+
* <b>Asynchronous idempotent delete APIs</b>
|
|
709
|
+
* </p>
|
|
710
|
+
* <p>Given a request action that has succeeded:</p>
|
|
711
|
+
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
712
|
+
* <code>DELETE_IN_PROGRESS</code>, the retry returns the resource detail data in the response without performing any
|
|
713
|
+
* further actions.</p>
|
|
714
|
+
* <p>If the original request delete operation is complete, a retry returns an empty response.</p>
|
|
715
|
+
* <p>Asynchronous idempotent delete APIs:</p>
|
|
716
|
+
* <ul>
|
|
717
|
+
* <li>
|
|
718
|
+
* <p>DeleteEnvironment</p>
|
|
719
|
+
* </li>
|
|
720
|
+
* <li>
|
|
721
|
+
* <p>DeleteService</p>
|
|
722
|
+
* </li>
|
|
723
|
+
* </ul>
|
|
724
|
+
*/
|
|
725
|
+
export declare class Proton extends ProtonClient implements Proton {
|
|
726
|
+
}
|