@aws-sdk/client-proton 3.180.0 → 3.181.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/README.md +1 -3
- package/dist-cjs/protocols/Aws_json1_0.js +84 -75
- package/dist-es/protocols/Aws_json1_0.js +91 -76
- package/dist-types/Proton.d.ts +78 -71
- package/dist-types/ProtonClient.d.ts +1 -3
- package/dist-types/commands/AcceptEnvironmentAccountConnectionCommand.d.ts +2 -2
- package/dist-types/commands/CancelComponentDeploymentCommand.d.ts +2 -2
- package/dist-types/commands/CancelEnvironmentDeploymentCommand.d.ts +2 -2
- package/dist-types/commands/CancelServiceInstanceDeploymentCommand.d.ts +2 -1
- package/dist-types/commands/CancelServicePipelineDeploymentCommand.d.ts +2 -1
- package/dist-types/commands/CreateComponentCommand.d.ts +2 -2
- package/dist-types/commands/CreateEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateEnvironmentTemplateCommand.d.ts +3 -3
- package/dist-types/commands/CreateRepositoryCommand.d.ts +6 -5
- package/dist-types/commands/CreateServiceCommand.d.ts +2 -3
- package/dist-types/commands/CreateServiceTemplateCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +5 -3
- package/dist-types/commands/DeleteComponentCommand.d.ts +2 -2
- package/dist-types/commands/DeleteEnvironmentAccountConnectionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteServiceCommand.d.ts +2 -2
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/GetComponentCommand.d.ts +2 -2
- package/dist-types/commands/GetEnvironmentAccountConnectionCommand.d.ts +2 -2
- package/dist-types/commands/GetRepositoryCommand.d.ts +1 -1
- package/dist-types/commands/GetRepositorySyncStatusCommand.d.ts +2 -2
- package/dist-types/commands/ListComponentOutputsCommand.d.ts +2 -2
- package/dist-types/commands/ListComponentProvisionedResourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListComponentsCommand.d.ts +2 -2
- package/dist-types/commands/ListEnvironmentAccountConnectionsCommand.d.ts +2 -2
- package/dist-types/commands/ListRepositoriesCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +1 -1
- package/dist-types/commands/RejectEnvironmentAccountConnectionCommand.d.ts +2 -2
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateComponentCommand.d.ts +2 -2
- package/dist-types/commands/UpdateEnvironmentAccountConnectionCommand.d.ts +2 -2
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateServiceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateTemplateSyncConfigCommand.d.ts +3 -1
- package/dist-types/models/models_0.d.ts +102 -87
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +3 -3
package/dist-types/Proton.d.ts
CHANGED
|
@@ -88,9 +88,7 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
88
88
|
* running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>,
|
|
89
89
|
* <i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and
|
|
90
90
|
* <i>update</i> API operations.</p>
|
|
91
|
-
* <p>To learn more about Proton
|
|
92
|
-
* Administrator Guide</a>.</p>
|
|
93
|
-
* <p>To learn more about deploying serverless and containerized applications on Proton, see the <a href="https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html">Proton User Guide</a>.</p>
|
|
91
|
+
* <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>
|
|
94
92
|
* <p>
|
|
95
93
|
* <b>Ensuring Idempotency</b>
|
|
96
94
|
* </p>
|
|
@@ -201,8 +199,8 @@ export declare class Proton extends ProtonClient {
|
|
|
201
199
|
/**
|
|
202
200
|
* <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton
|
|
203
201
|
* can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p>
|
|
204
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
205
|
-
* connections</a> in the <i>Proton
|
|
202
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
203
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
206
204
|
*/
|
|
207
205
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<AcceptEnvironmentAccountConnectionCommandOutput>;
|
|
208
206
|
acceptEnvironmentAccountConnection(args: AcceptEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: AcceptEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -210,16 +208,16 @@ export declare class Proton extends ProtonClient {
|
|
|
210
208
|
/**
|
|
211
209
|
* <p>Attempts to cancel a component deployment (for a component that is in the <code>IN_PROGRESS</code> deployment status).</p>
|
|
212
210
|
* <p>For more information about components, see
|
|
213
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
214
|
-
* <i>Proton
|
|
211
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
212
|
+
* <i>Proton User Guide</i>.</p>
|
|
215
213
|
*/
|
|
216
214
|
cancelComponentDeployment(args: CancelComponentDeploymentCommandInput, options?: __HttpHandlerOptions): Promise<CancelComponentDeploymentCommandOutput>;
|
|
217
215
|
cancelComponentDeployment(args: CancelComponentDeploymentCommandInput, cb: (err: any, data?: CancelComponentDeploymentCommandOutput) => void): void;
|
|
218
216
|
cancelComponentDeployment(args: CancelComponentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelComponentDeploymentCommandOutput) => void): void;
|
|
219
217
|
/**
|
|
220
218
|
* <p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more
|
|
221
|
-
* information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
222
|
-
*
|
|
219
|
+
* information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html">Update an environment</a> in the <i>Proton
|
|
220
|
+
* User guide</i>.</p>
|
|
223
221
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
224
222
|
* <ul>
|
|
225
223
|
* <li>
|
|
@@ -239,7 +237,8 @@ export declare class Proton extends ProtonClient {
|
|
|
239
237
|
cancelEnvironmentDeployment(args: CancelEnvironmentDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelEnvironmentDeploymentCommandOutput) => void): void;
|
|
240
238
|
/**
|
|
241
239
|
* <p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
242
|
-
* For more information, see <
|
|
240
|
+
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html">Update a service instance</a> in the
|
|
241
|
+
* <i>Proton User guide</i>.</p>
|
|
243
242
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
244
243
|
* <ul>
|
|
245
244
|
* <li>
|
|
@@ -259,7 +258,8 @@ export declare class Proton extends ProtonClient {
|
|
|
259
258
|
cancelServiceInstanceDeployment(args: CancelServiceInstanceDeploymentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelServiceInstanceDeploymentCommandOutput) => void): void;
|
|
260
259
|
/**
|
|
261
260
|
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
262
|
-
* For more information, see <
|
|
261
|
+
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html">Update a service pipeline</a> in the
|
|
262
|
+
* <i>Proton User guide</i>.</p>
|
|
263
263
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
264
264
|
* <ul>
|
|
265
265
|
* <li>
|
|
@@ -280,8 +280,8 @@ export declare class Proton extends ProtonClient {
|
|
|
280
280
|
/**
|
|
281
281
|
* <p>Create an Proton component. A component is an infrastructure extension for a service instance.</p>
|
|
282
282
|
* <p>For more information about components, see
|
|
283
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
284
|
-
* <i>Proton
|
|
283
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
284
|
+
* <i>Proton User Guide</i>.</p>
|
|
285
285
|
*/
|
|
286
286
|
createComponent(args: CreateComponentCommandInput, options?: __HttpHandlerOptions): Promise<CreateComponentCommandOutput>;
|
|
287
287
|
createComponent(args: CreateComponentCommandInput, cb: (err: any, data?: CreateComponentCommandOutput) => void): void;
|
|
@@ -301,7 +301,7 @@ export declare class Proton extends ProtonClient {
|
|
|
301
301
|
* engine uses to provision resources.</p>
|
|
302
302
|
* </li>
|
|
303
303
|
* </ul>
|
|
304
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
304
|
+
* <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
|
|
305
305
|
* Guide</i>.</p>
|
|
306
306
|
*/
|
|
307
307
|
createEnvironment(args: CreateEnvironmentCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentCommandOutput>;
|
|
@@ -311,14 +311,14 @@ export declare class Proton extends ProtonClient {
|
|
|
311
311
|
* <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment
|
|
312
312
|
* account from a management account.</p>
|
|
313
313
|
* <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an <i>environment
|
|
314
|
-
* account</i> that maintains authorization and permissions. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
314
|
+
* 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
|
|
315
315
|
* guide</i>.</p>
|
|
316
316
|
*/
|
|
317
317
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateEnvironmentAccountConnectionCommandOutput>;
|
|
318
318
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
319
319
|
createEnvironmentAccountConnection(args: CreateEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
320
320
|
/**
|
|
321
|
-
* <p>Create an environment template for Proton. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
321
|
+
* <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>
|
|
322
322
|
* <p>You can create an environment template in one of the two following ways:</p>
|
|
323
323
|
* <ul>
|
|
324
324
|
* <li>
|
|
@@ -329,8 +329,8 @@ export declare class Proton extends ProtonClient {
|
|
|
329
329
|
* <p>Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned
|
|
330
330
|
* infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment
|
|
331
331
|
* template for customer provisioned and managed infrastructure, include the <code>provisioning</code> parameter and set the value to
|
|
332
|
-
* <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
333
|
-
* and publish an environment template</a> in the <i>Proton
|
|
332
|
+
* <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/template-create.html">Register
|
|
333
|
+
* and publish an environment template</a> in the <i>Proton User Guide</i>.</p>
|
|
334
334
|
* </li>
|
|
335
335
|
* </ul>
|
|
336
336
|
*/
|
|
@@ -346,20 +346,20 @@ export declare class Proton extends ProtonClient {
|
|
|
346
346
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
347
347
|
createEnvironmentTemplateVersion(args: CreateEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
348
348
|
/**
|
|
349
|
-
* <p>Create and register a link to a repository
|
|
350
|
-
*
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
*
|
|
349
|
+
* <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
|
|
350
|
+
* provisioning) or pull from it (template sync). You can share a linked repository across multiple resources (like environments using self-managed
|
|
351
|
+
* 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>
|
|
352
|
+
* <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
|
|
353
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
|
|
354
|
+
* User Guide</i>.</p>
|
|
354
355
|
*/
|
|
355
356
|
createRepository(args: CreateRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<CreateRepositoryCommandOutput>;
|
|
356
357
|
createRepository(args: CreateRepositoryCommandInput, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
|
|
357
358
|
createRepository(args: CreateRepositoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRepositoryCommandOutput) => void): void;
|
|
358
359
|
/**
|
|
359
360
|
* <p>Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline.
|
|
360
|
-
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
361
|
-
*
|
|
362
|
-
* User Guide</i>.</p>
|
|
361
|
+
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-services.html">Services</a> in the <i>Proton User
|
|
362
|
+
* Guide</i>.</p>
|
|
363
363
|
*/
|
|
364
364
|
createService(args: CreateServiceCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceCommandOutput>;
|
|
365
365
|
createService(args: CreateServiceCommandInput, cb: (err: any, data?: CreateServiceCommandOutput) => void): void;
|
|
@@ -368,8 +368,8 @@ export declare class Proton extends ProtonClient {
|
|
|
368
368
|
* <p>Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline.
|
|
369
369
|
* Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a
|
|
370
370
|
* link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more
|
|
371
|
-
* information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
372
|
-
*
|
|
371
|
+
* information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-templates.html">Proton templates</a> in the <i>Proton User
|
|
372
|
+
* Guide</i>.</p>
|
|
373
373
|
*/
|
|
374
374
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, options?: __HttpHandlerOptions): Promise<CreateServiceTemplateCommandOutput>;
|
|
375
375
|
createServiceTemplate(args: CreateServiceTemplateCommandInput, cb: (err: any, data?: CreateServiceTemplateCommandOutput) => void): void;
|
|
@@ -382,9 +382,11 @@ export declare class Proton extends ProtonClient {
|
|
|
382
382
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
383
383
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
384
384
|
/**
|
|
385
|
-
* <p>Set up a template to create new template versions automatically
|
|
386
|
-
*
|
|
387
|
-
*
|
|
385
|
+
* <p>Set up a template to create new template versions automatically by tracking a linked repository. A linked repository is a repository that has been
|
|
386
|
+
* registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
387
|
+
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your repository template bundles. If it detects a template bundle
|
|
388
|
+
* change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton User
|
|
389
|
+
* Guide</i>.</p>
|
|
388
390
|
*/
|
|
389
391
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateSyncConfigCommandOutput>;
|
|
390
392
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void): void;
|
|
@@ -392,8 +394,8 @@ export declare class Proton extends ProtonClient {
|
|
|
392
394
|
/**
|
|
393
395
|
* <p>Delete an Proton component resource.</p>
|
|
394
396
|
* <p>For more information about components, see
|
|
395
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
396
|
-
* <i>Proton
|
|
397
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
398
|
+
* <i>Proton User Guide</i>.</p>
|
|
397
399
|
*/
|
|
398
400
|
deleteComponent(args: DeleteComponentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteComponentCommandOutput>;
|
|
399
401
|
deleteComponent(args: DeleteComponentCommandInput, cb: (err: any, data?: DeleteComponentCommandOutput) => void): void;
|
|
@@ -409,8 +411,8 @@ export declare class Proton extends ProtonClient {
|
|
|
409
411
|
* <p>After you delete an environment account connection that’s in use by an Proton environment, Proton <i>can’t</i> manage the
|
|
410
412
|
* environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're
|
|
411
413
|
* responsible for cleaning up provisioned resources that remain without an environment connection.</p>
|
|
412
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
413
|
-
* connections</a> in the <i>Proton
|
|
414
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
415
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
414
416
|
*/
|
|
415
417
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEnvironmentAccountConnectionCommandOutput>;
|
|
416
418
|
deleteEnvironmentAccountConnection(args: DeleteEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: DeleteEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -443,8 +445,8 @@ export declare class Proton extends ProtonClient {
|
|
|
443
445
|
* <note>
|
|
444
446
|
* <p>You can't delete a service if it has any service instances that have components attached to them.</p>
|
|
445
447
|
* <p>For more information about components, see
|
|
446
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
447
|
-
* <i>Proton
|
|
448
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
449
|
+
* <i>Proton User Guide</i>.</p>
|
|
448
450
|
* </note>
|
|
449
451
|
*/
|
|
450
452
|
deleteService(args: DeleteServiceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteServiceCommandOutput>;
|
|
@@ -474,7 +476,7 @@ export declare class Proton extends ProtonClient {
|
|
|
474
476
|
deleteTemplateSyncConfig(args: DeleteTemplateSyncConfigCommandInput, cb: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void): void;
|
|
475
477
|
deleteTemplateSyncConfig(args: DeleteTemplateSyncConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTemplateSyncConfigCommandOutput) => void): void;
|
|
476
478
|
/**
|
|
477
|
-
* <p>Get detail data for
|
|
479
|
+
* <p>Get detail data for Proton account-wide settings.</p>
|
|
478
480
|
*/
|
|
479
481
|
getAccountSettings(args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountSettingsCommandOutput>;
|
|
480
482
|
getAccountSettings(args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
@@ -482,8 +484,8 @@ export declare class Proton extends ProtonClient {
|
|
|
482
484
|
/**
|
|
483
485
|
* <p>Get detailed data for a component.</p>
|
|
484
486
|
* <p>For more information about components, see
|
|
485
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
486
|
-
* <i>Proton
|
|
487
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
488
|
+
* <i>Proton User Guide</i>.</p>
|
|
487
489
|
*/
|
|
488
490
|
getComponent(args: GetComponentCommandInput, options?: __HttpHandlerOptions): Promise<GetComponentCommandOutput>;
|
|
489
491
|
getComponent(args: GetComponentCommandInput, cb: (err: any, data?: GetComponentCommandOutput) => void): void;
|
|
@@ -496,8 +498,8 @@ export declare class Proton extends ProtonClient {
|
|
|
496
498
|
getEnvironment(args: GetEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentCommandOutput) => void): void;
|
|
497
499
|
/**
|
|
498
500
|
* <p>In an environment account, get the detailed data for an environment account connection.</p>
|
|
499
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
500
|
-
* connections</a> in the <i>Proton
|
|
501
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
502
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
501
503
|
*/
|
|
502
504
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<GetEnvironmentAccountConnectionCommandOutput>;
|
|
503
505
|
getEnvironmentAccountConnection(args: GetEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: GetEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -515,7 +517,7 @@ export declare class Proton extends ProtonClient {
|
|
|
515
517
|
getEnvironmentTemplateVersion(args: GetEnvironmentTemplateVersionCommandInput, cb: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
516
518
|
getEnvironmentTemplateVersion(args: GetEnvironmentTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEnvironmentTemplateVersionCommandOutput) => void): void;
|
|
517
519
|
/**
|
|
518
|
-
* <p>Get detail data for a repository.</p>
|
|
520
|
+
* <p>Get detail data for a linked repository.</p>
|
|
519
521
|
*/
|
|
520
522
|
getRepository(args: GetRepositoryCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositoryCommandOutput>;
|
|
521
523
|
getRepository(args: GetRepositoryCommandInput, cb: (err: any, data?: GetRepositoryCommandOutput) => void): void;
|
|
@@ -526,8 +528,8 @@ export declare class Proton extends ProtonClient {
|
|
|
526
528
|
* <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
|
|
527
529
|
* have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control
|
|
528
530
|
* (ABAC).</p>
|
|
529
|
-
* <p>For more information about ABAC, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
530
|
-
*
|
|
531
|
+
* <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
|
|
532
|
+
* Guide</i>.</p>
|
|
531
533
|
* </note>
|
|
532
534
|
*/
|
|
533
535
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositorySyncStatusCommandOutput>;
|
|
@@ -572,8 +574,8 @@ export declare class Proton extends ProtonClient {
|
|
|
572
574
|
/**
|
|
573
575
|
* <p>Get a list of component Infrastructure as Code (IaC) outputs.</p>
|
|
574
576
|
* <p>For more information about components, see
|
|
575
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
576
|
-
* <i>Proton
|
|
577
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
578
|
+
* <i>Proton User Guide</i>.</p>
|
|
577
579
|
*/
|
|
578
580
|
listComponentOutputs(args: ListComponentOutputsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentOutputsCommandOutput>;
|
|
579
581
|
listComponentOutputs(args: ListComponentOutputsCommandInput, cb: (err: any, data?: ListComponentOutputsCommandOutput) => void): void;
|
|
@@ -581,8 +583,8 @@ export declare class Proton extends ProtonClient {
|
|
|
581
583
|
/**
|
|
582
584
|
* <p>List provisioned resources for a component with details.</p>
|
|
583
585
|
* <p>For more information about components, see
|
|
584
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
585
|
-
* <i>Proton
|
|
586
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
587
|
+
* <i>Proton User Guide</i>.</p>
|
|
586
588
|
*/
|
|
587
589
|
listComponentProvisionedResources(args: ListComponentProvisionedResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentProvisionedResourcesCommandOutput>;
|
|
588
590
|
listComponentProvisionedResources(args: ListComponentProvisionedResourcesCommandInput, cb: (err: any, data?: ListComponentProvisionedResourcesCommandOutput) => void): void;
|
|
@@ -590,16 +592,16 @@ export declare class Proton extends ProtonClient {
|
|
|
590
592
|
/**
|
|
591
593
|
* <p>List components with summary data. You can filter the result list by environment, service, or a single service instance.</p>
|
|
592
594
|
* <p>For more information about components, see
|
|
593
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
594
|
-
* <i>Proton
|
|
595
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
596
|
+
* <i>Proton User Guide</i>.</p>
|
|
595
597
|
*/
|
|
596
598
|
listComponents(args: ListComponentsCommandInput, options?: __HttpHandlerOptions): Promise<ListComponentsCommandOutput>;
|
|
597
599
|
listComponents(args: ListComponentsCommandInput, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
|
|
598
600
|
listComponents(args: ListComponentsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComponentsCommandOutput) => void): void;
|
|
599
601
|
/**
|
|
600
602
|
* <p>View a list of environment account connections.</p>
|
|
601
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
602
|
-
* connections</a> in the <i>Proton
|
|
603
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
604
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
603
605
|
*/
|
|
604
606
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListEnvironmentAccountConnectionsCommandOutput>;
|
|
605
607
|
listEnvironmentAccountConnections(args: ListEnvironmentAccountConnectionsCommandInput, cb: (err: any, data?: ListEnvironmentAccountConnectionsCommandOutput) => void): void;
|
|
@@ -635,7 +637,7 @@ export declare class Proton extends ProtonClient {
|
|
|
635
637
|
listEnvironmentTemplateVersions(args: ListEnvironmentTemplateVersionsCommandInput, cb: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void): void;
|
|
636
638
|
listEnvironmentTemplateVersions(args: ListEnvironmentTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEnvironmentTemplateVersionsCommandOutput) => void): void;
|
|
637
639
|
/**
|
|
638
|
-
* <p>List repositories with detail data.</p>
|
|
640
|
+
* <p>List linked repositories with detail data.</p>
|
|
639
641
|
*/
|
|
640
642
|
listRepositories(args: ListRepositoriesCommandInput, options?: __HttpHandlerOptions): Promise<ListRepositoriesCommandOutput>;
|
|
641
643
|
listRepositories(args: ListRepositoriesCommandInput, cb: (err: any, data?: ListRepositoriesCommandOutput) => void): void;
|
|
@@ -695,14 +697,15 @@ export declare class Proton extends ProtonClient {
|
|
|
695
697
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void): void;
|
|
696
698
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void): void;
|
|
697
699
|
/**
|
|
698
|
-
* <p>List tags for a resource. For more information, see <
|
|
700
|
+
* <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
|
|
701
|
+
* tagging</a> in the <i>Proton User Guide</i>.</p>
|
|
699
702
|
*/
|
|
700
703
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
701
704
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
702
705
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
703
706
|
/**
|
|
704
707
|
* <p>Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.</p>
|
|
705
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
708
|
+
* <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> in the <i>Proton User Guide</i>.</p>
|
|
706
709
|
*/
|
|
707
710
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, options?: __HttpHandlerOptions): Promise<NotifyResourceDeploymentStatusChangeCommandOutput>;
|
|
708
711
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void): void;
|
|
@@ -712,28 +715,30 @@ export declare class Proton extends ProtonClient {
|
|
|
712
715
|
* <p>After you reject an environment account connection request, you <i>can't</i> accept or use the rejected environment account
|
|
713
716
|
* connection.</p>
|
|
714
717
|
* <p>You <i>can’t</i> reject an environment account connection that's connected to an environment.</p>
|
|
715
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
716
|
-
* connections</a> in the <i>Proton
|
|
718
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
719
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
717
720
|
*/
|
|
718
721
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<RejectEnvironmentAccountConnectionCommandOutput>;
|
|
719
722
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
720
723
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
721
724
|
/**
|
|
722
725
|
* <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p>
|
|
723
|
-
* <p>For more information, see <
|
|
726
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
727
|
+
* <i>Proton User Guide</i>.</p>
|
|
724
728
|
*/
|
|
725
729
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
726
730
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
727
731
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
728
732
|
/**
|
|
729
733
|
* <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.</p>
|
|
730
|
-
* <p>For more information, see <
|
|
734
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the
|
|
735
|
+
* <i>Proton User Guide</i>.</p>
|
|
731
736
|
*/
|
|
732
737
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
733
738
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
734
739
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
735
740
|
/**
|
|
736
|
-
* <p>Update
|
|
741
|
+
* <p>Update Proton settings that are used for multiple services in the Amazon Web Services account.</p>
|
|
737
742
|
*/
|
|
738
743
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountSettingsCommandOutput>;
|
|
739
744
|
updateAccountSettings(args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
@@ -746,8 +751,8 @@ export declare class Proton extends ProtonClient {
|
|
|
746
751
|
* <code>IN_PROGRESS</code>.</p>
|
|
747
752
|
* </note>
|
|
748
753
|
* <p>For more information about components, see
|
|
749
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
750
|
-
* <i>Proton
|
|
754
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
755
|
+
* <i>Proton User Guide</i>.</p>
|
|
751
756
|
*/
|
|
752
757
|
updateComponent(args: UpdateComponentCommandInput, options?: __HttpHandlerOptions): Promise<UpdateComponentCommandOutput>;
|
|
753
758
|
updateComponent(args: UpdateComponentCommandInput, cb: (err: any, data?: UpdateComponentCommandOutput) => void): void;
|
|
@@ -766,7 +771,7 @@ export declare class Proton extends ProtonClient {
|
|
|
766
771
|
* <p>If the environment was configured for Amazon Web Services-managed provisioning, omit the <code>provisioningRepository</code> parameter.</p>
|
|
767
772
|
* <p>If the environment was configured for self-managed provisioning, specify the <code>provisioningRepository</code> parameter and omit the
|
|
768
773
|
* <code>protonServiceRoleArn</code> and <code>environmentAccountConnectionId</code> parameters.</p>
|
|
769
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
774
|
+
* <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
|
|
770
775
|
* Guide</i>.</p>
|
|
771
776
|
* <p>There are four modes for updating an environment. The <code>deploymentType</code> field defines the mode.</p>
|
|
772
777
|
* <dl>
|
|
@@ -808,8 +813,8 @@ export declare class Proton extends ProtonClient {
|
|
|
808
813
|
updateEnvironment(args: UpdateEnvironmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEnvironmentCommandOutput) => void): void;
|
|
809
814
|
/**
|
|
810
815
|
* <p>In an environment account, update an environment account connection to use a new IAM role.</p>
|
|
811
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
812
|
-
* connections</a> in the <i>Proton
|
|
816
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
817
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
813
818
|
*/
|
|
814
819
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateEnvironmentAccountConnectionCommandOutput>;
|
|
815
820
|
updateEnvironmentAccountConnection(args: UpdateEnvironmentAccountConnectionCommandInput, cb: (err: any, data?: UpdateEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
@@ -836,8 +841,8 @@ export declare class Proton extends ProtonClient {
|
|
|
836
841
|
* <note>
|
|
837
842
|
* <p>You can't delete a service instance (remove it from the spec) if it has an attached component.</p>
|
|
838
843
|
* <p>For more information about components, see
|
|
839
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
840
|
-
* <i>Proton
|
|
844
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
845
|
+
* <i>Proton User Guide</i>.</p>
|
|
841
846
|
* </note>
|
|
842
847
|
*/
|
|
843
848
|
updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceCommandOutput>;
|
|
@@ -850,8 +855,8 @@ export declare class Proton extends ProtonClient {
|
|
|
850
855
|
* <p>You can't update a service instance while its deployment status, or the deployment status of a component attached to it, is
|
|
851
856
|
* <code>IN_PROGRESS</code>.</p>
|
|
852
857
|
* <p>For more information about components, see
|
|
853
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
854
|
-
* <i>Proton
|
|
858
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
859
|
+
* <i>Proton User Guide</i>.</p>
|
|
855
860
|
* </note>
|
|
856
861
|
*/
|
|
857
862
|
updateServiceInstance(args: UpdateServiceInstanceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceInstanceCommandOutput>;
|
|
@@ -910,7 +915,9 @@ export declare class Proton extends ProtonClient {
|
|
|
910
915
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void): void;
|
|
911
916
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void): void;
|
|
912
917
|
/**
|
|
913
|
-
* <p>Update template sync configuration parameters, except for the <code>templateName</code> and <code>templateType</code
|
|
918
|
+
* <p>Update template sync configuration parameters, except for the <code>templateName</code> and <code>templateType</code>. Repository details (branch,
|
|
919
|
+
* name, and provider) should be of a linked repository. A linked repository is a repository that has been registered with Proton. For more information,
|
|
920
|
+
* see <a>CreateRepository</a>.</p>
|
|
914
921
|
*/
|
|
915
922
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTemplateSyncConfigCommandOutput>;
|
|
916
923
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, cb: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void): void;
|
|
@@ -213,9 +213,7 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
|
|
|
213
213
|
* running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>,
|
|
214
214
|
* <i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and
|
|
215
215
|
* <i>update</i> API operations.</p>
|
|
216
|
-
* <p>To learn more about Proton
|
|
217
|
-
* Administrator Guide</a>.</p>
|
|
218
|
-
* <p>To learn more about deploying serverless and containerized applications on Proton, see the <a href="https://docs.aws.amazon.com/proton/latest/userguide/Welcome.html">Proton User Guide</a>.</p>
|
|
216
|
+
* <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>
|
|
219
217
|
* <p>
|
|
220
218
|
* <b>Ensuring Idempotency</b>
|
|
221
219
|
* </p>
|
|
@@ -9,8 +9,8 @@ export interface AcceptEnvironmentAccountConnectionCommandOutput extends AcceptE
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton
|
|
11
11
|
* can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p>
|
|
12
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
13
|
-
* connections</a> in the <i>Proton
|
|
12
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-account-connections.html">Environment account
|
|
13
|
+
* connections</a> in the <i>Proton User guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -9,8 +9,8 @@ export interface CancelComponentDeploymentCommandOutput extends CancelComponentD
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Attempts to cancel a component deployment (for a component that is in the <code>IN_PROGRESS</code> deployment status).</p>
|
|
11
11
|
* <p>For more information about components, see
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
13
|
-
* <i>Proton
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
13
|
+
* <i>Proton User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -8,8 +8,8 @@ export interface CancelEnvironmentDeploymentCommandOutput extends CancelEnvironm
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>. For more
|
|
11
|
-
* information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
12
|
-
*
|
|
11
|
+
* information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-env-update.html">Update an environment</a> in the <i>Proton
|
|
12
|
+
* User guide</i>.</p>
|
|
13
13
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
14
14
|
* <ul>
|
|
15
15
|
* <li>
|
|
@@ -8,7 +8,8 @@ export interface CancelServiceInstanceDeploymentCommandOutput extends CancelServ
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
11
|
-
* For more information, see <
|
|
11
|
+
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html">Update a service instance</a> in the
|
|
12
|
+
* <i>Proton User guide</i>.</p>
|
|
12
13
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
13
14
|
* <ul>
|
|
14
15
|
* <li>
|
|
@@ -8,7 +8,8 @@ export interface CancelServicePipelineDeploymentCommandOutput extends CancelServ
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is <code>IN_PROGRESS</code>.
|
|
11
|
-
* For more information, see <
|
|
11
|
+
* For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html">Update a service pipeline</a> in the
|
|
12
|
+
* <i>Proton User guide</i>.</p>
|
|
12
13
|
* <p>The following list includes potential cancellation scenarios.</p>
|
|
13
14
|
* <ul>
|
|
14
15
|
* <li>
|
|
@@ -9,8 +9,8 @@ export interface CreateComponentCommandOutput extends CreateComponentOutput, __M
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Create an Proton component. A component is an infrastructure extension for a service instance.</p>
|
|
11
11
|
* <p>For more information about components, see
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/proton/latest/
|
|
13
|
-
* <i>Proton
|
|
12
|
+
* <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the
|
|
13
|
+
* <i>Proton User Guide</i>.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface CreateEnvironmentAccountConnectionCommandOutput extends CreateE
|
|
|
10
10
|
* <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment
|
|
11
11
|
* account from a management account.</p>
|
|
12
12
|
* <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an <i>environment
|
|
13
|
-
* account</i> that maintains authorization and permissions. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
13
|
+
* 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
|
|
14
14
|
* guide</i>.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,7 +21,7 @@ export interface CreateEnvironmentCommandOutput extends CreateEnvironmentOutput,
|
|
|
21
21
|
* engine uses to provision resources.</p>
|
|
22
22
|
* </li>
|
|
23
23
|
* </ul>
|
|
24
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
24
|
+
* <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
|
|
25
25
|
* Guide</i>.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface CreateEnvironmentTemplateCommandInput extends CreateEnvironment
|
|
|
7
7
|
export interface CreateEnvironmentTemplateCommandOutput extends CreateEnvironmentTemplateOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Create an environment template for Proton. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
10
|
+
* <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>
|
|
11
11
|
* <p>You can create an environment template in one of the two following ways:</p>
|
|
12
12
|
* <ul>
|
|
13
13
|
* <li>
|
|
@@ -18,8 +18,8 @@ export interface CreateEnvironmentTemplateCommandOutput extends CreateEnvironmen
|
|
|
18
18
|
* <p>Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned
|
|
19
19
|
* infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment
|
|
20
20
|
* template for customer provisioned and managed infrastructure, include the <code>provisioning</code> parameter and set the value to
|
|
21
|
-
* <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/
|
|
22
|
-
* and publish an environment template</a> in the <i>Proton
|
|
21
|
+
* <code>CUSTOMER_MANAGED</code>. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/template-create.html">Register
|
|
22
|
+
* and publish an environment template</a> in the <i>Proton User Guide</i>.</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* </ul>
|
|
25
25
|
* @example
|