@aws-sdk/client-proton 3.55.0 → 3.63.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/README.md +36 -46
  3. package/dist-cjs/protocols/Aws_json1_0.js +1 -0
  4. package/dist-es/protocols/Aws_json1_0.js +1 -1
  5. package/dist-types/Proton.d.ts +153 -162
  6. package/dist-types/ProtonClient.d.ts +36 -46
  7. package/dist-types/commands/AcceptEnvironmentAccountConnectionCommand.d.ts +3 -3
  8. package/dist-types/commands/CancelEnvironmentDeploymentCommand.d.ts +4 -4
  9. package/dist-types/commands/CancelServiceInstanceDeploymentCommand.d.ts +4 -4
  10. package/dist-types/commands/CancelServicePipelineDeploymentCommand.d.ts +4 -4
  11. package/dist-types/commands/CreateEnvironmentAccountConnectionCommand.d.ts +5 -5
  12. package/dist-types/commands/CreateEnvironmentCommand.d.ts +7 -8
  13. package/dist-types/commands/CreateEnvironmentTemplateCommand.d.ts +5 -4
  14. package/dist-types/commands/CreateEnvironmentTemplateVersionCommand.d.ts +2 -2
  15. package/dist-types/commands/CreateRepositoryCommand.d.ts +5 -3
  16. package/dist-types/commands/CreateServiceCommand.d.ts +4 -4
  17. package/dist-types/commands/CreateServiceTemplateCommand.d.ts +5 -5
  18. package/dist-types/commands/CreateServiceTemplateVersionCommand.d.ts +2 -2
  19. package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +3 -4
  20. package/dist-types/commands/DeleteEnvironmentAccountConnectionCommand.d.ts +3 -3
  21. package/dist-types/commands/DeleteEnvironmentTemplateVersionCommand.d.ts +4 -4
  22. package/dist-types/commands/DeleteServiceTemplateVersionCommand.d.ts +6 -6
  23. package/dist-types/commands/GetEnvironmentAccountConnectionCommand.d.ts +1 -1
  24. package/dist-types/commands/GetRepositorySyncStatusCommand.d.ts +8 -1
  25. package/dist-types/commands/GetServiceInstanceCommand.d.ts +1 -2
  26. package/dist-types/commands/ListEnvironmentAccountConnectionsCommand.d.ts +1 -1
  27. package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +2 -7
  28. package/dist-types/commands/RejectEnvironmentAccountConnectionCommand.d.ts +4 -4
  29. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  30. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  31. package/dist-types/commands/UpdateEnvironmentAccountConnectionCommand.d.ts +1 -1
  32. package/dist-types/commands/UpdateEnvironmentCommand.d.ts +19 -18
  33. package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +5 -7
  34. package/dist-types/commands/UpdateServicePipelineCommand.d.ts +5 -7
  35. package/dist-types/models/models_0.d.ts +180 -227
  36. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  37. package/package.json +18 -18
@@ -193,55 +193,48 @@ declare type ProtonClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
193
193
  export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigType {
194
194
  }
195
195
  /**
196
- * <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
197
- * <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
198
- * service.</p>
196
+ * <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html">actions</a> and <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Types.html">data types</a> for the Proton service.</p>
199
197
  * <p>The documentation for each action shows the Query API request parameters and the XML response.</p>
200
- * <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
201
- * Guide</a>.</p>
202
- * <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide
203
- * standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in
204
- * turn, select from the available service templates to automate their application or service deployments.</p>
205
- * <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need
206
- * permissions to use all of the listed API operations.</p>
207
- * <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To
208
- * monitor their applications that are running on Proton, developers need permissions to the service
209
- * <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i>
210
- * API operations and the service instance <i>list</i> and <i>update</i> API
211
- * operations.</p>
212
- * <p>To learn more about Proton administration, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html">Proton Administrator Guide</a>.</p>
198
+ * <p>Alternatively, you can use the Amazon Web Services CLI to access an API. For more information, see the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">Amazon Web Services Command Line Interface User Guide</a>.</p>
199
+ * <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure
200
+ * and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to
201
+ * automate their application or service deployments.</p>
202
+ * <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the
203
+ * listed API operations.</p>
204
+ * <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are
205
+ * running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>,
206
+ * <i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and
207
+ * <i>update</i> API operations.</p>
208
+ * <p>To learn more about Proton administration, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html">Proton
209
+ * Administrator Guide</a>.</p>
213
210
  * <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>
214
211
  * <p>
215
212
  * <b>Ensuring Idempotency</b>
216
213
  * </p>
217
- * <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
218
- * of the operation are complete. Operations might also time out or encounter other server issues before they're
219
- * complete, even if the request already returned a result. This might make it difficult to determine whether the
220
- * request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation
221
- * completes successfully. However, if the original request and the subsequent retries are successful, the operation
222
- * occurs multiple times. This means that you might create more resources than you intended.</p>
214
+ * <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete.
215
+ * Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might
216
+ * make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the
217
+ * operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times.
218
+ * This means that you might create more resources than you intended.</p>
223
219
  * <p>
224
- * <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
225
- * idempotent request, if the original request action completes successfully, any subsequent retries complete
226
- * successfully without performing any further actions. However, the result might contain updated information, such as
227
- * the current creation status.</p>
220
+ * <i>Idempotency</i> ensures that an API request action completes no more than one time. With an idempotent request, if the
221
+ * original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the
222
+ * result might contain updated information, such as the current creation status.</p>
228
223
  * <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
229
224
  * <p>
230
225
  * <b>Idempotent create APIs with a client token</b>
231
226
  * </p>
232
- * <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
233
- * corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,
234
- * case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,
235
- * specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token
236
- * for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically
237
- * provided by SDKs.</p>
227
+ * <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The corresponding Amazon Web Services CLI commands
228
+ * also support idempotency using a client token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an
229
+ * idempotent API request using one of these actions, specify a client token in the request. We recommend that you <i>don't</i> reuse
230
+ * the same client token for other API requests. If you dont provide a client token for these APIs, a default client token is automatically provided
231
+ * by SDKs.</p>
238
232
  * <p>Given a request action that has succeeded:</p>
239
- * <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
240
- * performing any further actions other than returning the original resource detail data in the response.</p>
241
- * <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
242
- * throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
243
- * <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
244
- * resource is created.</p>
233
+ * <p>If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other
234
+ * than returning the original resource detail data in the response.</p>
235
+ * <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a
236
+ * <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
237
+ * <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new resource is created.</p>
245
238
  * <p>If the original resource is deleted and you retry the request, a new resource is created.</p>
246
239
  * <p>Idempotent create APIs with a client token:</p>
247
240
  * <ul>
@@ -259,9 +252,8 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
259
252
  * <b>Idempotent create APIs</b>
260
253
  * </p>
261
254
  * <p>Given a request action that has succeeded:</p>
262
- * <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
263
- * modified, the retry succeeds without performing any further actions other than returning the original resource detail
264
- * data in the response.</p>
255
+ * <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been modified, the retry succeeds
256
+ * without performing any further actions other than returning the original resource detail data in the response.</p>
265
257
  * <p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
266
258
  * <p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
267
259
  * <code>IdempotentParameterMismatch</code> error.</p>
@@ -284,8 +276,7 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
284
276
  * <b>Idempotent delete APIs</b>
285
277
  * </p>
286
278
  * <p>Given a request action that has succeeded:</p>
287
- * <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
288
- * the response.</p>
279
+ * <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in the response.</p>
289
280
  * <p>If you retry and the resource doesn't exist, the response is empty.</p>
290
281
  * <p>In both cases, the retry succeeds.</p>
291
282
  * <p>Idempotent delete APIs:</p>
@@ -310,9 +301,8 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
310
301
  * <b>Asynchronous idempotent delete APIs</b>
311
302
  * </p>
312
303
  * <p>Given a request action that has succeeded:</p>
313
- * <p>If you retry the request with an API from this group, if the original request delete operation status is
314
- * <code>DELETE_IN_PROGRESS</code>, the retry returns the resource detail data in the response without performing any
315
- * further actions.</p>
304
+ * <p>If you retry the request with an API from this group, if the original request delete operation status is <code>DELETE_IN_PROGRESS</code>, the
305
+ * retry returns the resource detail data in the response without performing any further actions.</p>
316
306
  * <p>If the original request delete operation is complete, a retry returns an empty response.</p>
317
307
  * <p>Asynchronous idempotent delete APIs:</p>
318
308
  * <ul>
@@ -7,10 +7,10 @@ export interface AcceptEnvironmentAccountConnectionCommandInput extends AcceptEn
7
7
  export interface AcceptEnvironmentAccountConnectionCommandOutput extends AcceptEnvironmentAccountConnectionOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted,
11
- * Proton can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p>
10
+ * <p>In a management account, an environment account connection request is accepted. When the environment account connection request is accepted, Proton
11
+ * can use the associated IAM role to provision environment infrastructure resources in the associated environment account.</p>
12
12
  * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
13
- * connections</a> in the <i>Proton Administrator guide</i>.</p>
13
+ * connections</a> in the <i>Proton Administrator 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
@@ -7,9 +7,9 @@ export interface CancelEnvironmentDeploymentCommandInput extends CancelEnvironme
7
7
  export interface CancelEnvironmentDeploymentCommandOutput extends CancelEnvironmentDeploymentOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Attempts to cancel an environment deployment on an <a>UpdateEnvironment</a> action, if the deployment is <code>IN_PROGRESS</code>.
11
- * For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-update.html">Update an environment</a> in the
12
- * <i>Proton Administrator guide</i>.</p>
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/adminguide/ag-env-update.html">Update an environment</a> in the <i>Proton
12
+ * Administrator guide</i>.</p>
13
13
  * <p>The following list includes potential cancellation scenarios.</p>
14
14
  * <ul>
15
15
  * <li>
@@ -20,7 +20,7 @@ export interface CancelEnvironmentDeploymentCommandOutput extends CancelEnvironm
20
20
  * </li>
21
21
  * <li>
22
22
  * <p>If the current <a>UpdateEnvironment</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
23
- * <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
23
+ * <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
24
24
  * </li>
25
25
  * </ul>
26
26
  * @example
@@ -7,8 +7,8 @@ export interface CancelServiceInstanceDeploymentCommandInput extends CancelServi
7
7
  export interface CancelServiceInstanceDeploymentCommandOutput extends CancelServiceInstanceDeploymentOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Attempts to cancel a service instance deployment on an <a>UpdateServiceInstance</a> action, if the deployment is
11
- * <code>IN_PROGRESS</code>. For more information, see <i>Update a service instance</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html">Proton Administrator guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html">Proton User guide</a>.</p>
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 <i>Update a service instance</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html">Proton Administrator guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html">Proton User guide</a>.</p>
12
12
  * <p>The following list includes potential cancellation scenarios.</p>
13
13
  * <ul>
14
14
  * <li>
@@ -18,8 +18,8 @@ export interface CancelServiceInstanceDeploymentCommandOutput extends CancelServ
18
18
  * <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p>
19
19
  * </li>
20
20
  * <li>
21
- * <p>If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment
22
- * state is <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
21
+ * <p>If the current <a>UpdateServiceInstance</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
22
+ * <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
23
23
  * </li>
24
24
  * </ul>
25
25
  * @example
@@ -7,8 +7,8 @@ export interface CancelServicePipelineDeploymentCommandInput extends CancelServi
7
7
  export interface CancelServicePipelineDeploymentCommandOutput extends CancelServicePipelineDeploymentOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Attempts to cancel a service pipeline deployment on an <a>UpdateServicePipeline</a> action, if the deployment is
11
- * <code>IN_PROGRESS</code>. For more information, see <i>Update a service pipeline</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html">Proton Administrator guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html">Proton User guide</a>.</p>
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 <i>Update a service pipeline</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html">Proton Administrator guide</a> or the <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-pipeline-update.html">Proton User guide</a>.</p>
12
12
  * <p>The following list includes potential cancellation scenarios.</p>
13
13
  * <ul>
14
14
  * <li>
@@ -18,8 +18,8 @@ export interface CancelServicePipelineDeploymentCommandOutput extends CancelServ
18
18
  * <p>If the cancellation attempt fails, the resulting deployment state is <code>FAILED</code>.</p>
19
19
  * </li>
20
20
  * <li>
21
- * <p>If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment
22
- * state is <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
21
+ * <p>If the current <a>UpdateServicePipeline</a> action succeeds before the cancellation attempt starts, the resulting deployment state is
22
+ * <code>SUCCEEDED</code> and the cancellation attempt has no effect.</p>
23
23
  * </li>
24
24
  * </ul>
25
25
  * @example
@@ -7,11 +7,11 @@ export interface CreateEnvironmentAccountConnectionCommandInput extends CreateEn
7
7
  export interface CreateEnvironmentAccountConnectionCommandOutput extends CreateEnvironmentAccountConnectionOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the
11
- * environment account from a management account.</p>
12
- * <p>An environment account connection is a secure bi-directional connection between a <i>management account</i> and an
13
- * <i>environment account</i> that maintains authorization and permissions. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton Administrator
14
- * guide</i>.</p>
10
+ * <p>Create an environment account connection in an environment account so that environment infrastructure resources can be provisioned in the environment
11
+ * account from a management account.</p>
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/adminguide/ag-env-account-connections.html">Environment account connections</a> in the <i>Proton Administrator
14
+ * guide</i>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -7,23 +7,22 @@ export interface CreateEnvironmentCommandInput extends CreateEnvironmentInput {
7
7
  export interface CreateEnvironmentCommandOutput extends CreateEnvironmentOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can
11
- * be shared across services.</p>
10
+ * <p>Deploy a new environment. An Proton environment is created from an environment template that defines infrastructure and resources that can be
11
+ * shared across services.</p>
12
12
  * <p class="title">
13
13
  * <b>You can provision environments using the following methods:</b>
14
14
  * </p>
15
15
  * <ul>
16
16
  * <li>
17
- * <p>Standard provisioning: Proton makes direct calls to provision your resources.</p>
17
+ * <p>Amazon Web Services-managed provisioning: Proton makes direct calls to provision your resources.</p>
18
18
  * </li>
19
19
  * <li>
20
- * <p>Pull request provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your
21
- * IaC engine uses to provision resources.</p>
20
+ * <p>Self-managed provisioning: Proton makes pull requests on your repository to provide compiled infrastructure as code (IaC) files that your IaC
21
+ * engine uses to provision resources.</p>
22
22
  * </li>
23
23
  * </ul>
24
- * <p>For more information, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html">Environments</a> in the
25
- * <i>Proton Administrator Guide.</i>
26
- * </p>
24
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-environments.html">Environments</a> and <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html">Provisioning methods</a> in the <i>Proton Administrator
25
+ * Guide</i>.</p>
27
26
  * @example
28
27
  * Use a bare-bones client and the command you need to make an API call.
29
28
  * ```javascript
@@ -12,13 +12,14 @@ export interface CreateEnvironmentTemplateCommandOutput extends CreateEnvironmen
12
12
  * <ul>
13
13
  * <li>
14
14
  * <p>Register and publish a <i>standard</i> environment template that instructs Proton to deploy and manage environment
15
- * infrastructure.</p>
15
+ * infrastructure.</p>
16
16
  * </li>
17
17
  * <li>
18
18
  * <p>Register and publish a <i>customer managed</i> environment template that connects Proton to your existing provisioned
19
- * infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment
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/adminguide/template-create.html">Register and publish an environment template</a> in the <i>Proton Administrator Guide</i>.</p>
19
+ * infrastructure that you manage. Proton <i>doesn't</i> manage your existing provisioned infrastructure. To create an environment
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/adminguide/template-create.html">Register
22
+ * and publish an environment template</a> in the <i>Proton Administrator Guide</i>.</p>
22
23
  * </li>
23
24
  * </ul>
24
25
  * @example
@@ -8,8 +8,8 @@ export interface CreateEnvironmentTemplateVersionCommandOutput extends CreateEnv
8
8
  }
9
9
  /**
10
10
  * <p>Create a new major or minor version of an environment template. A major version of an environment template is a version that
11
- * <i>isn't</i> backwards compatible. A minor version of an environment template is a version that's backwards compatible within its
12
- * major version.</p>
11
+ * <i>isn't</i> backwards compatible. A minor version of an environment template is a version that's backwards compatible within its major
12
+ * version.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -7,9 +7,11 @@ export interface CreateRepositoryCommandInput extends CreateRepositoryInput {
7
7
  export interface CreateRepositoryCommandOutput extends CreateRepositoryOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Create and register a link to a repository that can be used with pull request provisioning or template sync configurations. For more
11
- * information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html">Template bundles</a> and <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
12
- * Administrator Guide</i>.</p>
10
+ * <p>Create and register a link to a repository that can be used with self-managed provisioning (infrastructure or pipelines) or for template sync
11
+ * configurations. When you create a repository link, Proton creates a <a href="https://docs.aws.amazon.com/proton/latest/adminguide/using-service-linked-roles.html">service-linked role</a> for you.</p>
12
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a>, <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html">Template bundles</a>, and
13
+ * <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
14
+ * Administrator Guide</i>.</p>
13
15
  * @example
14
16
  * Use a bare-bones client and the command you need to make an API call.
15
17
  * ```javascript
@@ -7,10 +7,10 @@ export interface CreateServiceCommandInput extends CreateServiceInput {
7
7
  export interface CreateServiceCommandOutput extends CreateServiceOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and
11
- * pipeline. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html">Services</a> in the
12
- * <i>Proton Administrator Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html">Services</a>
13
- * in the <i>Proton User Guide</i>.</p>
10
+ * <p>Create an Proton service. An Proton service is an instantiation of a service template and often includes several service instances and pipeline.
11
+ * For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-services.html">Services</a> in the <i>Proton
12
+ * Administrator Guide</i> and <a href="https://docs.aws.amazon.com/proton/latest/userguide/ug-service.html">Services</a> in the <i>Proton
13
+ * 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
@@ -7,11 +7,11 @@ export interface CreateServiceTemplateCommandInput extends CreateServiceTemplate
7
7
  export interface CreateServiceTemplateCommandOutput extends CreateServiceTemplateOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CICD service
11
- * pipeline. Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition,
12
- * they provide a link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service
13
- * template. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html">Service
14
- * Templates</a> in the <i>Proton Administrator Guide</i>.</p>
10
+ * <p>Create a service template. The administrator creates a service template to define standardized infrastructure and an optional CI/CD service pipeline.
11
+ * Developers, in turn, select the service template from Proton. If the selected service template includes a service pipeline definition, they provide a
12
+ * link to their source code repository. Proton then deploys and manages the infrastructure defined by the selected service template. For more
13
+ * information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/managing-svc-templates.html">Service Templates</a> in the
14
+ * <i>Proton Administrator Guide</i>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -7,8 +7,8 @@ export interface CreateServiceTemplateVersionCommandInput extends CreateServiceT
7
7
  export interface CreateServiceTemplateVersionCommandOutput extends CreateServiceTemplateVersionOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Create a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i>
11
- * backward compatible. A minor version of a service template is a version that's backward compatible within its major version.</p>
10
+ * <p>Create a new major or minor version of a service template. A major version of a service template is a version that <i>isn't</i> backward
11
+ * compatible. A minor version of a service template is a version that's backward compatible within its major version.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -7,10 +7,9 @@ export interface CreateTemplateSyncConfigCommandInput extends CreateTemplateSync
7
7
  export interface CreateTemplateSyncConfigCommandOutput extends CreateTemplateSyncConfigOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Set up a template for automated template version creation. When a commit is pushed to your registered <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Repository.html">repository</a>, Proton checks for changes to your repository template bundles. If it
11
- * detects a template bundle change, a new minor or major version of its template is created, if the version doesn’t already exist. For more
12
- * information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html">Template sync configurations</a> in
13
- * the <i>Proton Administrator Guide</i>.</p>
10
+ * <p>Set up a template to create new template versions automatically. When a commit is pushed to your registered <a href="https://docs.aws.amazon.com/proton/latest/APIReference/API_Repository.html">repository</a>, Proton checks for changes to your repository template bundles. If it detects
11
+ * a template bundle change, a new major or minor version of its template is created, if the version doesn’t already exist. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-sync-configs.html">Template sync configurations</a> in the <i>Proton
12
+ * Administrator Guide</i>.</p>
14
13
  * @example
15
14
  * Use a bare-bones client and the command you need to make an API call.
16
15
  * ```javascript
@@ -9,10 +9,10 @@ export interface DeleteEnvironmentAccountConnectionCommandOutput extends DeleteE
9
9
  /**
10
10
  * <p>In an environment account, delete an environment account connection.</p>
11
11
  * <p>After you delete an environment account connection that’s in use by an Proton environment, Proton <i>can’t</i> manage the
12
- * environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment.
13
- * You're responsible for cleaning up provisioned resources that remain without an environment connection.</p>
12
+ * environment infrastructure resources until a new environment account connection is accepted for the environment account and associated environment. You're
13
+ * responsible for cleaning up provisioned resources that remain without an environment connection.</p>
14
14
  * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
15
- * connections</a> in the <i>Proton Administrator guide</i>.</p>
15
+ * connections</a> in the <i>Proton Administrator guide</i>.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -8,11 +8,11 @@ export interface DeleteEnvironmentTemplateVersionCommandOutput extends DeleteEnv
8
8
  }
9
9
  /**
10
10
  * <p>If no other minor versions of an environment template exist, delete a major version of the environment template if it's not the
11
- * <code>Recommended</code> version. Delete the <code>Recommended</code> version of the environment template if no other major versions or minor
12
- * versions of the environment template exist. A major version of an environment template is a version that's not backward compatible.</p>
11
+ * <code>Recommended</code> version. Delete the <code>Recommended</code> version of the environment template if no other major versions or minor versions
12
+ * of the environment template exist. A major version of an environment template is a version that's not backward compatible.</p>
13
13
  * <p>Delete a minor version of an environment template if it <i>isn't</i> the <code>Recommended</code> version. Delete a
14
- * <code>Recommended</code> minor version of the environment template if no other minor versions of the environment template exist. A minor version
15
- * of an environment template is a version that's backward compatible.</p>
14
+ * <code>Recommended</code> minor version of the environment template if no other minor versions of the environment template exist. A minor version of an
15
+ * environment template is a version that's backward compatible.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -7,12 +7,12 @@ export interface DeleteServiceTemplateVersionCommandInput extends DeleteServiceT
7
7
  export interface DeleteServiceTemplateVersionCommandOutput extends DeleteServiceTemplateVersionOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>If no other minor versions of a service template exist, delete a major version of the service template if it's not the
11
- * <code>Recommended</code> version. Delete the <code>Recommended</code> version of the service template if no other major versions or minor versions
12
- * of the service template exist. A major version of a service template is a version that <i>isn't</i> backwards compatible.</p>
13
- * <p>Delete a minor version of a service template if it's not the <code>Recommended</code> version. Delete a <code>Recommended</code> minor version
14
- * of the service template if no other minor versions of the service template exist. A minor version of a service template is a version that's
15
- * backwards compatible.</p>
10
+ * <p>If no other minor versions of a service template exist, delete a major version of the service template if it's not the <code>Recommended</code>
11
+ * version. Delete the <code>Recommended</code> version of the service template if no other major versions or minor versions of the service template exist. A
12
+ * major version of a service template is a version that <i>isn't</i> backwards compatible.</p>
13
+ * <p>Delete a minor version of a service template if it's not the <code>Recommended</code> version. Delete a <code>Recommended</code> minor version of the
14
+ * service template if no other minor versions of the service template exist. A minor version of a service template is a version that's backwards
15
+ * compatible.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -9,7 +9,7 @@ export interface GetEnvironmentAccountConnectionCommandOutput extends GetEnviron
9
9
  /**
10
10
  * <p>In an environment account, view the detail data for an environment account connection.</p>
11
11
  * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
12
- * connections</a> in the <i>Proton Administrator guide</i>.</p>
12
+ * connections</a> in the <i>Proton Administrator guide</i>.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -7,7 +7,14 @@ export interface GetRepositorySyncStatusCommandInput extends GetRepositorySyncSt
7
7
  export interface GetRepositorySyncStatusCommandOutput extends GetRepositorySyncStatusOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Get the repository sync status.</p>
10
+ * <p>Get the sync status of a repository used for Proton template sync. For more information about template sync, see .</p>
11
+ * <note>
12
+ * <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
13
+ * have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control
14
+ * (ABAC).</p>
15
+ * <p>For more information about ABAC, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags">ABAC</a> in the <i>Proton
16
+ * Administrator Guide</i>.</p>
17
+ * </note>
11
18
  * @example
12
19
  * Use a bare-bones client and the command you need to make an API call.
13
20
  * ```javascript
@@ -7,8 +7,7 @@ export interface GetServiceInstanceCommandInput extends GetServiceInstanceInput
7
7
  export interface GetServiceInstanceCommandOutput extends GetServiceInstanceOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Get detail data for a service instance. A service instance is an instantiation of service template, which is running in a specific
11
- * environment.</p>
10
+ * <p>Get detail data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.</p>
12
11
  * @example
13
12
  * Use a bare-bones client and the command you need to make an API call.
14
13
  * ```javascript
@@ -9,7 +9,7 @@ export interface ListEnvironmentAccountConnectionsCommandOutput extends ListEnvi
9
9
  /**
10
10
  * <p>View a list of environment account connections.</p>
11
11
  * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
12
- * connections</a> in the <i>Proton Administrator guide</i>.</p>
12
+ * connections</a> in the <i>Proton Administrator guide</i>.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -7,13 +7,8 @@ export interface NotifyResourceDeploymentStatusChangeCommandInput extends Notify
7
7
  export interface NotifyResourceDeploymentStatusChangeCommandOutput extends NotifyResourceDeploymentStatusChangeOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Notify Proton of status changes to a provisioned resource when you use pull request provisioning. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-template-bundles.html">Template bundles</a>.</p>
11
- * <important>
12
- * <p>Provisioning by pull request is currently in feature preview and is
13
- * only usable with Terraform based Proton Templates. To learn more about
14
- * <a href="https://aws.amazon.com/service-terms">Amazon Web Services Feature Preview terms</a>, see section 2 on Beta and
15
- * Previews.</p>
16
- * </important>
10
+ * <p>Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.</p>
11
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-works-prov-methods.html#ag-works-prov-methods-self">Self-managed provisioning</a> in the <i>Proton Administrator Guide</i>.</p>
17
12
  * @example
18
13
  * Use a bare-bones client and the command you need to make an API call.
19
14
  * ```javascript
@@ -8,11 +8,11 @@ export interface RejectEnvironmentAccountConnectionCommandOutput extends RejectE
8
8
  }
9
9
  /**
10
10
  * <p>In a management account, reject an environment account connection from another environment account.</p>
11
- * <p>After you reject an environment account connection request, you <i>won’t</i> be able to accept or use the rejected environment
12
- * account connection.</p>
13
- * <p>You <i>can’t</i> reject an environment account connection that is connected to an environment.</p>
11
+ * <p>After you reject an environment account connection request, you <i>can't</i> accept or use the rejected environment account
12
+ * connection.</p>
13
+ * <p>You <i>can’t</i> reject an environment account connection that's connected to an environment.</p>
14
14
  * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
15
- * connections</a> in the <i>Proton Administrator guide</i>.</p>
15
+ * connections</a> in the <i>Proton Administrator guide</i>.</p>
16
16
  * @example
17
17
  * Use a bare-bones client and the command you need to make an API call.
18
18
  * ```javascript
@@ -7,7 +7,8 @@ export interface TagResourceCommandInput extends TagResourceInput {
7
7
  export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Tag a resource. For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
10
+ * <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p>
11
+ * <p>For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -7,7 +7,8 @@ export interface UntagResourceCommandInput extends UntagResourceInput {
7
7
  export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Remove a tag from a resource. For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
10
+ * <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton resource.</p>
11
+ * <p>For more information, see <i>Proton resources and tagging</i> in the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/resources.html">Proton Administrator Guide</a> or <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton User Guide</a>.</p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -9,7 +9,7 @@ export interface UpdateEnvironmentAccountConnectionCommandOutput extends UpdateE
9
9
  /**
10
10
  * <p>In an environment account, update an environment account connection to use a new IAM role.</p>
11
11
  * <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/adminguide/ag-env-account-connections.html">Environment account
12
- * connections</a> in the <i>Proton Administrator guide</i>.</p>
12
+ * connections</a> in the <i>Proton Administrator guide</i>.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript