@aws-sdk/client-proton 3.264.0 → 3.265.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/README.md +45 -34
- package/dist-cjs/Proton.js +15 -0
- package/dist-cjs/commands/GetResourcesSummaryCommand.js +46 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +19 -3
- package/dist-cjs/protocols/Aws_json1_0.js +93 -3
- package/dist-es/Proton.js +15 -0
- package/dist-es/commands/GetResourcesSummaryCommand.js +42 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +12 -0
- package/dist-es/protocols/Aws_json1_0.js +88 -1
- package/dist-types/Proton.d.ts +82 -51
- package/dist-types/ProtonClient.d.ts +48 -36
- package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +6 -5
- package/dist-types/commands/GetResourcesSummaryCommand.d.ts +46 -0
- package/dist-types/commands/ListServiceInstancesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -3
- package/dist-types/commands/UpdateTemplateSyncConfigCommand.d.ts +3 -3
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +109 -17
- package/dist-types/protocols/Aws_json1_0.d.ts +3 -0
- package/dist-types/ts3.4/Proton.d.ts +17 -0
- package/dist-types/ts3.4/ProtonClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GetResourcesSummaryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +32 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +12 -0
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpRequest as __HttpRequest } from "@aws-sdk/protocol-http";
|
|
2
|
-
import { decorateServiceException as __decorateServiceException, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectString as __expectString, parseEpochTimestamp as __parseEpochTimestamp, throwDefaultError, } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectString as __expectString, parseEpochTimestamp as __parseEpochTimestamp, throwDefaultError, } from "@aws-sdk/smithy-client";
|
|
3
3
|
import { v4 as generateIdempotencyToken } from "uuid";
|
|
4
4
|
import { AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, TemplateVersionSourceInput, ThrottlingException, ValidationException, } from "../models/models_0";
|
|
5
5
|
import { ProtonServiceException as __BaseException } from "../models/ProtonServiceException";
|
|
@@ -300,6 +300,15 @@ export const serializeAws_json1_0GetRepositorySyncStatusCommand = async (input,
|
|
|
300
300
|
body = JSON.stringify(serializeAws_json1_0GetRepositorySyncStatusInput(input, context));
|
|
301
301
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
302
302
|
};
|
|
303
|
+
export const serializeAws_json1_0GetResourcesSummaryCommand = async (input, context) => {
|
|
304
|
+
const headers = {
|
|
305
|
+
"content-type": "application/x-amz-json-1.0",
|
|
306
|
+
"x-amz-target": "AwsProton20200720.GetResourcesSummary",
|
|
307
|
+
};
|
|
308
|
+
let body;
|
|
309
|
+
body = JSON.stringify(serializeAws_json1_0GetResourcesSummaryInput(input, context));
|
|
310
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
311
|
+
};
|
|
303
312
|
export const serializeAws_json1_0GetServiceCommand = async (input, context) => {
|
|
304
313
|
const headers = {
|
|
305
314
|
"content-type": "application/x-amz-json-1.0",
|
|
@@ -2253,6 +2262,48 @@ const deserializeAws_json1_0GetRepositorySyncStatusCommandError = async (output,
|
|
|
2253
2262
|
});
|
|
2254
2263
|
}
|
|
2255
2264
|
};
|
|
2265
|
+
export const deserializeAws_json1_0GetResourcesSummaryCommand = async (output, context) => {
|
|
2266
|
+
if (output.statusCode >= 300) {
|
|
2267
|
+
return deserializeAws_json1_0GetResourcesSummaryCommandError(output, context);
|
|
2268
|
+
}
|
|
2269
|
+
const data = await parseBody(output.body, context);
|
|
2270
|
+
let contents = {};
|
|
2271
|
+
contents = deserializeAws_json1_0GetResourcesSummaryOutput(data, context);
|
|
2272
|
+
const response = {
|
|
2273
|
+
$metadata: deserializeMetadata(output),
|
|
2274
|
+
...contents,
|
|
2275
|
+
};
|
|
2276
|
+
return Promise.resolve(response);
|
|
2277
|
+
};
|
|
2278
|
+
const deserializeAws_json1_0GetResourcesSummaryCommandError = async (output, context) => {
|
|
2279
|
+
const parsedOutput = {
|
|
2280
|
+
...output,
|
|
2281
|
+
body: await parseErrorBody(output.body, context),
|
|
2282
|
+
};
|
|
2283
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
2284
|
+
switch (errorCode) {
|
|
2285
|
+
case "AccessDeniedException":
|
|
2286
|
+
case "com.amazonaws.proton#AccessDeniedException":
|
|
2287
|
+
throw await deserializeAws_json1_0AccessDeniedExceptionResponse(parsedOutput, context);
|
|
2288
|
+
case "InternalServerException":
|
|
2289
|
+
case "com.amazonaws.proton#InternalServerException":
|
|
2290
|
+
throw await deserializeAws_json1_0InternalServerExceptionResponse(parsedOutput, context);
|
|
2291
|
+
case "ThrottlingException":
|
|
2292
|
+
case "com.amazonaws.proton#ThrottlingException":
|
|
2293
|
+
throw await deserializeAws_json1_0ThrottlingExceptionResponse(parsedOutput, context);
|
|
2294
|
+
case "ValidationException":
|
|
2295
|
+
case "com.amazonaws.proton#ValidationException":
|
|
2296
|
+
throw await deserializeAws_json1_0ValidationExceptionResponse(parsedOutput, context);
|
|
2297
|
+
default:
|
|
2298
|
+
const parsedBody = parsedOutput.body;
|
|
2299
|
+
throwDefaultError({
|
|
2300
|
+
output,
|
|
2301
|
+
parsedBody,
|
|
2302
|
+
exceptionCtor: __BaseException,
|
|
2303
|
+
errorCode,
|
|
2304
|
+
});
|
|
2305
|
+
}
|
|
2306
|
+
};
|
|
2256
2307
|
export const deserializeAws_json1_0GetServiceCommand = async (output, context) => {
|
|
2257
2308
|
if (output.statusCode >= 300) {
|
|
2258
2309
|
return deserializeAws_json1_0GetServiceCommandError(output, context);
|
|
@@ -4524,6 +4575,9 @@ const serializeAws_json1_0GetRepositorySyncStatusInput = (input, context) => {
|
|
|
4524
4575
|
...(input.syncType != null && { syncType: input.syncType }),
|
|
4525
4576
|
};
|
|
4526
4577
|
};
|
|
4578
|
+
const serializeAws_json1_0GetResourcesSummaryInput = (input, context) => {
|
|
4579
|
+
return {};
|
|
4580
|
+
};
|
|
4527
4581
|
const serializeAws_json1_0GetServiceInput = (input, context) => {
|
|
4528
4582
|
return {
|
|
4529
4583
|
...(input.name != null && { name: input.name }),
|
|
@@ -5048,6 +5102,25 @@ const deserializeAws_json1_0ConflictException = (output, context) => {
|
|
|
5048
5102
|
message: __expectString(output.message),
|
|
5049
5103
|
};
|
|
5050
5104
|
};
|
|
5105
|
+
const deserializeAws_json1_0CountsSummary = (output, context) => {
|
|
5106
|
+
return {
|
|
5107
|
+
components: output.components != null ? deserializeAws_json1_0ResourceCountsSummary(output.components, context) : undefined,
|
|
5108
|
+
environmentTemplates: output.environmentTemplates != null
|
|
5109
|
+
? deserializeAws_json1_0ResourceCountsSummary(output.environmentTemplates, context)
|
|
5110
|
+
: undefined,
|
|
5111
|
+
environments: output.environments != null
|
|
5112
|
+
? deserializeAws_json1_0ResourceCountsSummary(output.environments, context)
|
|
5113
|
+
: undefined,
|
|
5114
|
+
pipelines: output.pipelines != null ? deserializeAws_json1_0ResourceCountsSummary(output.pipelines, context) : undefined,
|
|
5115
|
+
serviceInstances: output.serviceInstances != null
|
|
5116
|
+
? deserializeAws_json1_0ResourceCountsSummary(output.serviceInstances, context)
|
|
5117
|
+
: undefined,
|
|
5118
|
+
serviceTemplates: output.serviceTemplates != null
|
|
5119
|
+
? deserializeAws_json1_0ResourceCountsSummary(output.serviceTemplates, context)
|
|
5120
|
+
: undefined,
|
|
5121
|
+
services: output.services != null ? deserializeAws_json1_0ResourceCountsSummary(output.services, context) : undefined,
|
|
5122
|
+
};
|
|
5123
|
+
};
|
|
5051
5124
|
const deserializeAws_json1_0CreateComponentOutput = (output, context) => {
|
|
5052
5125
|
return {
|
|
5053
5126
|
component: output.component != null ? deserializeAws_json1_0Component(output.component, context) : undefined,
|
|
@@ -5416,6 +5489,11 @@ const deserializeAws_json1_0GetRepositorySyncStatusOutput = (output, context) =>
|
|
|
5416
5489
|
latestSync: output.latestSync != null ? deserializeAws_json1_0RepositorySyncAttempt(output.latestSync, context) : undefined,
|
|
5417
5490
|
};
|
|
5418
5491
|
};
|
|
5492
|
+
const deserializeAws_json1_0GetResourcesSummaryOutput = (output, context) => {
|
|
5493
|
+
return {
|
|
5494
|
+
counts: output.counts != null ? deserializeAws_json1_0CountsSummary(output.counts, context) : undefined,
|
|
5495
|
+
};
|
|
5496
|
+
};
|
|
5419
5497
|
const deserializeAws_json1_0GetServiceInstanceOutput = (output, context) => {
|
|
5420
5498
|
return {
|
|
5421
5499
|
serviceInstance: output.serviceInstance != null
|
|
@@ -5734,6 +5812,15 @@ const deserializeAws_json1_0RepositorySyncEvents = (output, context) => {
|
|
|
5734
5812
|
});
|
|
5735
5813
|
return retVal;
|
|
5736
5814
|
};
|
|
5815
|
+
const deserializeAws_json1_0ResourceCountsSummary = (output, context) => {
|
|
5816
|
+
return {
|
|
5817
|
+
behindMajor: __expectInt32(output.behindMajor),
|
|
5818
|
+
behindMinor: __expectInt32(output.behindMinor),
|
|
5819
|
+
failed: __expectInt32(output.failed),
|
|
5820
|
+
total: __expectInt32(output.total),
|
|
5821
|
+
upToDate: __expectInt32(output.upToDate),
|
|
5822
|
+
};
|
|
5823
|
+
};
|
|
5737
5824
|
const deserializeAws_json1_0ResourceNotFoundException = (output, context) => {
|
|
5738
5825
|
return {
|
|
5739
5826
|
message: __expectString(output.message),
|
package/dist-types/Proton.d.ts
CHANGED
|
@@ -32,6 +32,7 @@ import { GetEnvironmentTemplateCommandInput, GetEnvironmentTemplateCommandOutput
|
|
|
32
32
|
import { GetEnvironmentTemplateVersionCommandInput, GetEnvironmentTemplateVersionCommandOutput } from "./commands/GetEnvironmentTemplateVersionCommand";
|
|
33
33
|
import { GetRepositoryCommandInput, GetRepositoryCommandOutput } from "./commands/GetRepositoryCommand";
|
|
34
34
|
import { GetRepositorySyncStatusCommandInput, GetRepositorySyncStatusCommandOutput } from "./commands/GetRepositorySyncStatusCommand";
|
|
35
|
+
import { GetResourcesSummaryCommandInput, GetResourcesSummaryCommandOutput } from "./commands/GetResourcesSummaryCommand";
|
|
35
36
|
import { GetServiceCommandInput, GetServiceCommandOutput } from "./commands/GetServiceCommand";
|
|
36
37
|
import { GetServiceInstanceCommandInput, GetServiceInstanceCommandOutput } from "./commands/GetServiceInstanceCommand";
|
|
37
38
|
import { GetServiceTemplateCommandInput, GetServiceTemplateCommandOutput } from "./commands/GetServiceTemplateCommand";
|
|
@@ -76,46 +77,54 @@ import { UpdateServiceTemplateVersionCommandInput, UpdateServiceTemplateVersionC
|
|
|
76
77
|
import { UpdateTemplateSyncConfigCommandInput, UpdateTemplateSyncConfigCommandOutput } from "./commands/UpdateTemplateSyncConfigCommand";
|
|
77
78
|
import { ProtonClient } from "./ProtonClient";
|
|
78
79
|
/**
|
|
79
|
-
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
80
|
+
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
81
|
+
* <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
|
|
82
|
+
* service.</p>
|
|
80
83
|
* <p>The documentation for each action shows the Query API request parameters and the XML response.</p>
|
|
81
|
-
* <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
|
|
82
|
-
*
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* <i>update</i>
|
|
84
|
+
* <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
|
|
85
|
+
* Guide</a>.</p>
|
|
86
|
+
* <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide
|
|
87
|
+
* standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in
|
|
88
|
+
* turn, select from the available service templates to automate their application or service deployments.</p>
|
|
89
|
+
* <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need
|
|
90
|
+
* permissions to use all of the listed API operations.</p>
|
|
91
|
+
* <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To
|
|
92
|
+
* monitor their applications that are running on Proton, developers need permissions to the service
|
|
93
|
+
* <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i>
|
|
94
|
+
* API operations and the service instance <i>list</i> and <i>update</i> API
|
|
95
|
+
* operations.</p>
|
|
91
96
|
* <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>
|
|
92
97
|
* <p>
|
|
93
98
|
* <b>Ensuring Idempotency</b>
|
|
94
99
|
* </p>
|
|
95
|
-
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
96
|
-
* Operations might also time out or encounter other server issues before they're
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
+
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
101
|
+
* of the operation are complete. Operations might also time out or encounter other server issues before they're
|
|
102
|
+
* complete, even if the request already returned a result. This might make it difficult to determine whether the
|
|
103
|
+
* request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation
|
|
104
|
+
* completes successfully. However, if the original request and the subsequent retries are successful, the operation
|
|
105
|
+
* occurs multiple times. This means that you might create more resources than you intended.</p>
|
|
100
106
|
* <p>
|
|
101
|
-
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
102
|
-
* original request action completes successfully, any subsequent retries complete
|
|
103
|
-
* result might contain updated information, such as
|
|
107
|
+
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
108
|
+
* idempotent request, if the original request action completes successfully, any subsequent retries complete
|
|
109
|
+
* successfully without performing any further actions. However, the result might contain updated information, such as
|
|
110
|
+
* the current creation status.</p>
|
|
104
111
|
* <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
|
|
105
112
|
* <p>
|
|
106
113
|
* <b>Idempotent create APIs with a client token</b>
|
|
107
114
|
* </p>
|
|
108
|
-
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
109
|
-
* also support idempotency using a client token. A client token is a unique,
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
115
|
+
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
116
|
+
* corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,
|
|
117
|
+
* case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,
|
|
118
|
+
* specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token
|
|
119
|
+
* for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically
|
|
120
|
+
* provided by SDKs.</p>
|
|
113
121
|
* <p>Given a request action that has succeeded:</p>
|
|
114
|
-
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
115
|
-
* than returning the original resource detail data in the response.</p>
|
|
116
|
-
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
117
|
-
*
|
|
118
|
-
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
122
|
+
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
123
|
+
* performing any further actions other than returning the original resource detail data in the response.</p>
|
|
124
|
+
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
125
|
+
* throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
|
|
126
|
+
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
127
|
+
* resource is created.</p>
|
|
119
128
|
* <p>If the original resource is deleted and you retry the request, a new resource is created.</p>
|
|
120
129
|
* <p>Idempotent create APIs with a client token:</p>
|
|
121
130
|
* <ul>
|
|
@@ -133,8 +142,9 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
133
142
|
* <b>Idempotent create APIs</b>
|
|
134
143
|
* </p>
|
|
135
144
|
* <p>Given a request action that has succeeded:</p>
|
|
136
|
-
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
137
|
-
* without performing any further actions other than returning the original resource detail
|
|
145
|
+
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
146
|
+
* modified, the retry succeeds without performing any further actions other than returning the original resource detail
|
|
147
|
+
* data in the response.</p>
|
|
138
148
|
* <p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
|
|
139
149
|
* <p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
|
|
140
150
|
* <code>IdempotentParameterMismatch</code> error.</p>
|
|
@@ -157,7 +167,8 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
157
167
|
* <b>Idempotent delete APIs</b>
|
|
158
168
|
* </p>
|
|
159
169
|
* <p>Given a request action that has succeeded:</p>
|
|
160
|
-
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
170
|
+
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
171
|
+
* the response.</p>
|
|
161
172
|
* <p>If you retry and the resource doesn't exist, the response is empty.</p>
|
|
162
173
|
* <p>In both cases, the retry succeeds.</p>
|
|
163
174
|
* <p>Idempotent delete APIs:</p>
|
|
@@ -182,8 +193,9 @@ import { ProtonClient } from "./ProtonClient";
|
|
|
182
193
|
* <b>Asynchronous idempotent delete APIs</b>
|
|
183
194
|
* </p>
|
|
184
195
|
* <p>Given a request action that has succeeded:</p>
|
|
185
|
-
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
186
|
-
*
|
|
196
|
+
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
197
|
+
* <code>DELETE_IN_PROGRESS</code>, the retry returns the resource detail data in the response without performing any
|
|
198
|
+
* further actions.</p>
|
|
187
199
|
* <p>If the original request delete operation is complete, a retry returns an empty response.</p>
|
|
188
200
|
* <p>Asynchronous idempotent delete APIs:</p>
|
|
189
201
|
* <ul>
|
|
@@ -382,11 +394,12 @@ export declare class Proton extends ProtonClient {
|
|
|
382
394
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
383
395
|
createServiceTemplateVersion(args: CreateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateServiceTemplateVersionCommandOutput) => void): void;
|
|
384
396
|
/**
|
|
385
|
-
* <p>Set up a template to create new template versions automatically by tracking a linked repository. A linked
|
|
386
|
-
*
|
|
387
|
-
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your repository template
|
|
388
|
-
*
|
|
389
|
-
*
|
|
397
|
+
* <p>Set up a template to create new template versions automatically by tracking a linked repository. A linked
|
|
398
|
+
* repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
399
|
+
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your repository template
|
|
400
|
+
* bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the
|
|
401
|
+
* 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
|
|
402
|
+
* <i>Proton User Guide</i>.</p>
|
|
390
403
|
*/
|
|
391
404
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateSyncConfigCommandOutput>;
|
|
392
405
|
createTemplateSyncConfig(args: CreateTemplateSyncConfigCommandInput, cb: (err: any, data?: CreateTemplateSyncConfigCommandOutput) => void): void;
|
|
@@ -535,6 +548,21 @@ export declare class Proton extends ProtonClient {
|
|
|
535
548
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetRepositorySyncStatusCommandOutput>;
|
|
536
549
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void): void;
|
|
537
550
|
getRepositorySyncStatus(args: GetRepositorySyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRepositorySyncStatusCommandOutput) => void): void;
|
|
551
|
+
/**
|
|
552
|
+
* <p>Get counts of Proton resources.</p>
|
|
553
|
+
* <p>For infrastructure-provisioning resources (environments, services, service instances, pipelines), the action
|
|
554
|
+
* returns staleness counts. A resource is stale when it's behind the recommended version of the Proton template that it
|
|
555
|
+
* uses and it needs an update to become current.</p>
|
|
556
|
+
* <p>The action returns staleness counts (counts of resources that are up-to-date, behind a template major version,
|
|
557
|
+
* or behind a template minor version), the total number of resources, and the number of resources that are in a failed
|
|
558
|
+
* state, grouped by resource type. Components, environments, and service templates are exceptions—see the
|
|
559
|
+
* <code>components</code>, <code>environments</code>, and <code>serviceTemplates</code> field descriptions.</p>
|
|
560
|
+
* <p>For context, the action also returns the total number of each type of Proton template in the Amazon Web Services account.</p>
|
|
561
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/monitoring-dashboard.html">Proton dashboard</a> in the <i>Proton User Guide</i>.</p>
|
|
562
|
+
*/
|
|
563
|
+
getResourcesSummary(args: GetResourcesSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetResourcesSummaryCommandOutput>;
|
|
564
|
+
getResourcesSummary(args: GetResourcesSummaryCommandInput, cb: (err: any, data?: GetResourcesSummaryCommandOutput) => void): void;
|
|
565
|
+
getResourcesSummary(args: GetResourcesSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourcesSummaryCommandOutput) => void): void;
|
|
538
566
|
/**
|
|
539
567
|
* <p>Get detailed data for a service.</p>
|
|
540
568
|
*/
|
|
@@ -661,7 +689,8 @@ export declare class Proton extends ProtonClient {
|
|
|
661
689
|
listServiceInstanceProvisionedResources(args: ListServiceInstanceProvisionedResourcesCommandInput, cb: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void): void;
|
|
662
690
|
listServiceInstanceProvisionedResources(args: ListServiceInstanceProvisionedResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceInstanceProvisionedResourcesCommandOutput) => void): void;
|
|
663
691
|
/**
|
|
664
|
-
* <p>List service instances with summary data. This action lists service instances of all services in the
|
|
692
|
+
* <p>List service instances with summary data. This action lists service instances of all services in the
|
|
693
|
+
* Amazon Web Services account.</p>
|
|
665
694
|
*/
|
|
666
695
|
listServiceInstances(args: ListServiceInstancesCommandInput, options?: __HttpHandlerOptions): Promise<ListServiceInstancesCommandOutput>;
|
|
667
696
|
listServiceInstances(args: ListServiceInstancesCommandInput, cb: (err: any, data?: ListServiceInstancesCommandOutput) => void): void;
|
|
@@ -697,15 +726,16 @@ export declare class Proton extends ProtonClient {
|
|
|
697
726
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void): void;
|
|
698
727
|
listServiceTemplateVersions(args: ListServiceTemplateVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListServiceTemplateVersionsCommandOutput) => void): void;
|
|
699
728
|
/**
|
|
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
|
-
*
|
|
729
|
+
* <p>List tags for a resource. For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton resources and tagging</a> in the <i>Proton User
|
|
730
|
+
* Guide</i>.</p>
|
|
702
731
|
*/
|
|
703
732
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
704
733
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
705
734
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
706
735
|
/**
|
|
707
736
|
* <p>Notify Proton of status changes to a provisioned resource when you use self-managed provisioning.</p>
|
|
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
|
|
737
|
+
* <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
|
|
738
|
+
* provisioning</a> in the <i>Proton User Guide</i>.</p>
|
|
709
739
|
*/
|
|
710
740
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, options?: __HttpHandlerOptions): Promise<NotifyResourceDeploymentStatusChangeCommandOutput>;
|
|
711
741
|
notifyResourceDeploymentStatusChange(args: NotifyResourceDeploymentStatusChangeCommandInput, cb: (err: any, data?: NotifyResourceDeploymentStatusChangeCommandOutput) => void): void;
|
|
@@ -723,16 +753,17 @@ export declare class Proton extends ProtonClient {
|
|
|
723
753
|
rejectEnvironmentAccountConnection(args: RejectEnvironmentAccountConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectEnvironmentAccountConnectionCommandOutput) => void): void;
|
|
724
754
|
/**
|
|
725
755
|
* <p>Tag a resource. A tag is a key-value pair of metadata that you associate with an Proton resource.</p>
|
|
726
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton
|
|
727
|
-
*
|
|
756
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton
|
|
757
|
+
* resources and tagging</a> in the <i>Proton User Guide</i>.</p>
|
|
728
758
|
*/
|
|
729
759
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
730
760
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
731
761
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
732
762
|
/**
|
|
733
|
-
* <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton
|
|
734
|
-
*
|
|
735
|
-
*
|
|
763
|
+
* <p>Remove a customer tag from a resource. A tag is a key-value pair of metadata associated with an Proton
|
|
764
|
+
* resource.</p>
|
|
765
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/resources.html">Proton
|
|
766
|
+
* resources and tagging</a> in the <i>Proton User Guide</i>.</p>
|
|
736
767
|
*/
|
|
737
768
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
738
769
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
@@ -915,9 +946,9 @@ export declare class Proton extends ProtonClient {
|
|
|
915
946
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void): void;
|
|
916
947
|
updateServiceTemplateVersion(args: UpdateServiceTemplateVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateServiceTemplateVersionCommandOutput) => void): void;
|
|
917
948
|
/**
|
|
918
|
-
* <p>Update template sync configuration parameters, except for the <code>templateName</code> and
|
|
919
|
-
*
|
|
920
|
-
*
|
|
949
|
+
* <p>Update template sync configuration parameters, except for the <code>templateName</code> and
|
|
950
|
+
* <code>templateType</code>. Repository details (branch, name, and provider) should be of a linked repository. A
|
|
951
|
+
* linked repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
921
952
|
*/
|
|
922
953
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTemplateSyncConfigCommandOutput>;
|
|
923
954
|
updateTemplateSyncConfig(args: UpdateTemplateSyncConfigCommandInput, cb: (err: any, data?: UpdateTemplateSyncConfigCommandOutput) => void): void;
|
|
@@ -40,6 +40,7 @@ import { GetEnvironmentTemplateCommandInput, GetEnvironmentTemplateCommandOutput
|
|
|
40
40
|
import { GetEnvironmentTemplateVersionCommandInput, GetEnvironmentTemplateVersionCommandOutput } from "./commands/GetEnvironmentTemplateVersionCommand";
|
|
41
41
|
import { GetRepositoryCommandInput, GetRepositoryCommandOutput } from "./commands/GetRepositoryCommand";
|
|
42
42
|
import { GetRepositorySyncStatusCommandInput, GetRepositorySyncStatusCommandOutput } from "./commands/GetRepositorySyncStatusCommand";
|
|
43
|
+
import { GetResourcesSummaryCommandInput, GetResourcesSummaryCommandOutput } from "./commands/GetResourcesSummaryCommand";
|
|
43
44
|
import { GetServiceCommandInput, GetServiceCommandOutput } from "./commands/GetServiceCommand";
|
|
44
45
|
import { GetServiceInstanceCommandInput, GetServiceInstanceCommandOutput } from "./commands/GetServiceInstanceCommand";
|
|
45
46
|
import { GetServiceTemplateCommandInput, GetServiceTemplateCommandOutput } from "./commands/GetServiceTemplateCommand";
|
|
@@ -83,8 +84,8 @@ import { UpdateServiceTemplateCommandInput, UpdateServiceTemplateCommandOutput }
|
|
|
83
84
|
import { UpdateServiceTemplateVersionCommandInput, UpdateServiceTemplateVersionCommandOutput } from "./commands/UpdateServiceTemplateVersionCommand";
|
|
84
85
|
import { UpdateTemplateSyncConfigCommandInput, UpdateTemplateSyncConfigCommandOutput } from "./commands/UpdateTemplateSyncConfigCommand";
|
|
85
86
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
86
|
-
export declare type ServiceInputTypes = AcceptEnvironmentAccountConnectionCommandInput | CancelComponentDeploymentCommandInput | CancelEnvironmentDeploymentCommandInput | CancelServiceInstanceDeploymentCommandInput | CancelServicePipelineDeploymentCommandInput | CreateComponentCommandInput | CreateEnvironmentAccountConnectionCommandInput | CreateEnvironmentCommandInput | CreateEnvironmentTemplateCommandInput | CreateEnvironmentTemplateVersionCommandInput | CreateRepositoryCommandInput | CreateServiceCommandInput | CreateServiceTemplateCommandInput | CreateServiceTemplateVersionCommandInput | CreateTemplateSyncConfigCommandInput | DeleteComponentCommandInput | DeleteEnvironmentAccountConnectionCommandInput | DeleteEnvironmentCommandInput | DeleteEnvironmentTemplateCommandInput | DeleteEnvironmentTemplateVersionCommandInput | DeleteRepositoryCommandInput | DeleteServiceCommandInput | DeleteServiceTemplateCommandInput | DeleteServiceTemplateVersionCommandInput | DeleteTemplateSyncConfigCommandInput | GetAccountSettingsCommandInput | GetComponentCommandInput | GetEnvironmentAccountConnectionCommandInput | GetEnvironmentCommandInput | GetEnvironmentTemplateCommandInput | GetEnvironmentTemplateVersionCommandInput | GetRepositoryCommandInput | GetRepositorySyncStatusCommandInput | GetServiceCommandInput | GetServiceInstanceCommandInput | GetServiceTemplateCommandInput | GetServiceTemplateVersionCommandInput | GetTemplateSyncConfigCommandInput | GetTemplateSyncStatusCommandInput | ListComponentOutputsCommandInput | ListComponentProvisionedResourcesCommandInput | ListComponentsCommandInput | ListEnvironmentAccountConnectionsCommandInput | ListEnvironmentOutputsCommandInput | ListEnvironmentProvisionedResourcesCommandInput | ListEnvironmentTemplateVersionsCommandInput | ListEnvironmentTemplatesCommandInput | ListEnvironmentsCommandInput | ListRepositoriesCommandInput | ListRepositorySyncDefinitionsCommandInput | ListServiceInstanceOutputsCommandInput | ListServiceInstanceProvisionedResourcesCommandInput | ListServiceInstancesCommandInput | ListServicePipelineOutputsCommandInput | ListServicePipelineProvisionedResourcesCommandInput | ListServiceTemplateVersionsCommandInput | ListServiceTemplatesCommandInput | ListServicesCommandInput | ListTagsForResourceCommandInput | NotifyResourceDeploymentStatusChangeCommandInput | RejectEnvironmentAccountConnectionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccountSettingsCommandInput | UpdateComponentCommandInput | UpdateEnvironmentAccountConnectionCommandInput | UpdateEnvironmentCommandInput | UpdateEnvironmentTemplateCommandInput | UpdateEnvironmentTemplateVersionCommandInput | UpdateServiceCommandInput | UpdateServiceInstanceCommandInput | UpdateServicePipelineCommandInput | UpdateServiceTemplateCommandInput | UpdateServiceTemplateVersionCommandInput | UpdateTemplateSyncConfigCommandInput;
|
|
87
|
-
export declare type ServiceOutputTypes = AcceptEnvironmentAccountConnectionCommandOutput | CancelComponentDeploymentCommandOutput | CancelEnvironmentDeploymentCommandOutput | CancelServiceInstanceDeploymentCommandOutput | CancelServicePipelineDeploymentCommandOutput | CreateComponentCommandOutput | CreateEnvironmentAccountConnectionCommandOutput | CreateEnvironmentCommandOutput | CreateEnvironmentTemplateCommandOutput | CreateEnvironmentTemplateVersionCommandOutput | CreateRepositoryCommandOutput | CreateServiceCommandOutput | CreateServiceTemplateCommandOutput | CreateServiceTemplateVersionCommandOutput | CreateTemplateSyncConfigCommandOutput | DeleteComponentCommandOutput | DeleteEnvironmentAccountConnectionCommandOutput | DeleteEnvironmentCommandOutput | DeleteEnvironmentTemplateCommandOutput | DeleteEnvironmentTemplateVersionCommandOutput | DeleteRepositoryCommandOutput | DeleteServiceCommandOutput | DeleteServiceTemplateCommandOutput | DeleteServiceTemplateVersionCommandOutput | DeleteTemplateSyncConfigCommandOutput | GetAccountSettingsCommandOutput | GetComponentCommandOutput | GetEnvironmentAccountConnectionCommandOutput | GetEnvironmentCommandOutput | GetEnvironmentTemplateCommandOutput | GetEnvironmentTemplateVersionCommandOutput | GetRepositoryCommandOutput | GetRepositorySyncStatusCommandOutput | GetServiceCommandOutput | GetServiceInstanceCommandOutput | GetServiceTemplateCommandOutput | GetServiceTemplateVersionCommandOutput | GetTemplateSyncConfigCommandOutput | GetTemplateSyncStatusCommandOutput | ListComponentOutputsCommandOutput | ListComponentProvisionedResourcesCommandOutput | ListComponentsCommandOutput | ListEnvironmentAccountConnectionsCommandOutput | ListEnvironmentOutputsCommandOutput | ListEnvironmentProvisionedResourcesCommandOutput | ListEnvironmentTemplateVersionsCommandOutput | ListEnvironmentTemplatesCommandOutput | ListEnvironmentsCommandOutput | ListRepositoriesCommandOutput | ListRepositorySyncDefinitionsCommandOutput | ListServiceInstanceOutputsCommandOutput | ListServiceInstanceProvisionedResourcesCommandOutput | ListServiceInstancesCommandOutput | ListServicePipelineOutputsCommandOutput | ListServicePipelineProvisionedResourcesCommandOutput | ListServiceTemplateVersionsCommandOutput | ListServiceTemplatesCommandOutput | ListServicesCommandOutput | ListTagsForResourceCommandOutput | NotifyResourceDeploymentStatusChangeCommandOutput | RejectEnvironmentAccountConnectionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccountSettingsCommandOutput | UpdateComponentCommandOutput | UpdateEnvironmentAccountConnectionCommandOutput | UpdateEnvironmentCommandOutput | UpdateEnvironmentTemplateCommandOutput | UpdateEnvironmentTemplateVersionCommandOutput | UpdateServiceCommandOutput | UpdateServiceInstanceCommandOutput | UpdateServicePipelineCommandOutput | UpdateServiceTemplateCommandOutput | UpdateServiceTemplateVersionCommandOutput | UpdateTemplateSyncConfigCommandOutput;
|
|
87
|
+
export declare type ServiceInputTypes = AcceptEnvironmentAccountConnectionCommandInput | CancelComponentDeploymentCommandInput | CancelEnvironmentDeploymentCommandInput | CancelServiceInstanceDeploymentCommandInput | CancelServicePipelineDeploymentCommandInput | CreateComponentCommandInput | CreateEnvironmentAccountConnectionCommandInput | CreateEnvironmentCommandInput | CreateEnvironmentTemplateCommandInput | CreateEnvironmentTemplateVersionCommandInput | CreateRepositoryCommandInput | CreateServiceCommandInput | CreateServiceTemplateCommandInput | CreateServiceTemplateVersionCommandInput | CreateTemplateSyncConfigCommandInput | DeleteComponentCommandInput | DeleteEnvironmentAccountConnectionCommandInput | DeleteEnvironmentCommandInput | DeleteEnvironmentTemplateCommandInput | DeleteEnvironmentTemplateVersionCommandInput | DeleteRepositoryCommandInput | DeleteServiceCommandInput | DeleteServiceTemplateCommandInput | DeleteServiceTemplateVersionCommandInput | DeleteTemplateSyncConfigCommandInput | GetAccountSettingsCommandInput | GetComponentCommandInput | GetEnvironmentAccountConnectionCommandInput | GetEnvironmentCommandInput | GetEnvironmentTemplateCommandInput | GetEnvironmentTemplateVersionCommandInput | GetRepositoryCommandInput | GetRepositorySyncStatusCommandInput | GetResourcesSummaryCommandInput | GetServiceCommandInput | GetServiceInstanceCommandInput | GetServiceTemplateCommandInput | GetServiceTemplateVersionCommandInput | GetTemplateSyncConfigCommandInput | GetTemplateSyncStatusCommandInput | ListComponentOutputsCommandInput | ListComponentProvisionedResourcesCommandInput | ListComponentsCommandInput | ListEnvironmentAccountConnectionsCommandInput | ListEnvironmentOutputsCommandInput | ListEnvironmentProvisionedResourcesCommandInput | ListEnvironmentTemplateVersionsCommandInput | ListEnvironmentTemplatesCommandInput | ListEnvironmentsCommandInput | ListRepositoriesCommandInput | ListRepositorySyncDefinitionsCommandInput | ListServiceInstanceOutputsCommandInput | ListServiceInstanceProvisionedResourcesCommandInput | ListServiceInstancesCommandInput | ListServicePipelineOutputsCommandInput | ListServicePipelineProvisionedResourcesCommandInput | ListServiceTemplateVersionsCommandInput | ListServiceTemplatesCommandInput | ListServicesCommandInput | ListTagsForResourceCommandInput | NotifyResourceDeploymentStatusChangeCommandInput | RejectEnvironmentAccountConnectionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccountSettingsCommandInput | UpdateComponentCommandInput | UpdateEnvironmentAccountConnectionCommandInput | UpdateEnvironmentCommandInput | UpdateEnvironmentTemplateCommandInput | UpdateEnvironmentTemplateVersionCommandInput | UpdateServiceCommandInput | UpdateServiceInstanceCommandInput | UpdateServicePipelineCommandInput | UpdateServiceTemplateCommandInput | UpdateServiceTemplateVersionCommandInput | UpdateTemplateSyncConfigCommandInput;
|
|
88
|
+
export declare type ServiceOutputTypes = AcceptEnvironmentAccountConnectionCommandOutput | CancelComponentDeploymentCommandOutput | CancelEnvironmentDeploymentCommandOutput | CancelServiceInstanceDeploymentCommandOutput | CancelServicePipelineDeploymentCommandOutput | CreateComponentCommandOutput | CreateEnvironmentAccountConnectionCommandOutput | CreateEnvironmentCommandOutput | CreateEnvironmentTemplateCommandOutput | CreateEnvironmentTemplateVersionCommandOutput | CreateRepositoryCommandOutput | CreateServiceCommandOutput | CreateServiceTemplateCommandOutput | CreateServiceTemplateVersionCommandOutput | CreateTemplateSyncConfigCommandOutput | DeleteComponentCommandOutput | DeleteEnvironmentAccountConnectionCommandOutput | DeleteEnvironmentCommandOutput | DeleteEnvironmentTemplateCommandOutput | DeleteEnvironmentTemplateVersionCommandOutput | DeleteRepositoryCommandOutput | DeleteServiceCommandOutput | DeleteServiceTemplateCommandOutput | DeleteServiceTemplateVersionCommandOutput | DeleteTemplateSyncConfigCommandOutput | GetAccountSettingsCommandOutput | GetComponentCommandOutput | GetEnvironmentAccountConnectionCommandOutput | GetEnvironmentCommandOutput | GetEnvironmentTemplateCommandOutput | GetEnvironmentTemplateVersionCommandOutput | GetRepositoryCommandOutput | GetRepositorySyncStatusCommandOutput | GetResourcesSummaryCommandOutput | GetServiceCommandOutput | GetServiceInstanceCommandOutput | GetServiceTemplateCommandOutput | GetServiceTemplateVersionCommandOutput | GetTemplateSyncConfigCommandOutput | GetTemplateSyncStatusCommandOutput | ListComponentOutputsCommandOutput | ListComponentProvisionedResourcesCommandOutput | ListComponentsCommandOutput | ListEnvironmentAccountConnectionsCommandOutput | ListEnvironmentOutputsCommandOutput | ListEnvironmentProvisionedResourcesCommandOutput | ListEnvironmentTemplateVersionsCommandOutput | ListEnvironmentTemplatesCommandOutput | ListEnvironmentsCommandOutput | ListRepositoriesCommandOutput | ListRepositorySyncDefinitionsCommandOutput | ListServiceInstanceOutputsCommandOutput | ListServiceInstanceProvisionedResourcesCommandOutput | ListServiceInstancesCommandOutput | ListServicePipelineOutputsCommandOutput | ListServicePipelineProvisionedResourcesCommandOutput | ListServiceTemplateVersionsCommandOutput | ListServiceTemplatesCommandOutput | ListServicesCommandOutput | ListTagsForResourceCommandOutput | NotifyResourceDeploymentStatusChangeCommandOutput | RejectEnvironmentAccountConnectionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccountSettingsCommandOutput | UpdateComponentCommandOutput | UpdateEnvironmentAccountConnectionCommandOutput | UpdateEnvironmentCommandOutput | UpdateEnvironmentTemplateCommandOutput | UpdateEnvironmentTemplateVersionCommandOutput | UpdateServiceCommandOutput | UpdateServiceInstanceCommandOutput | UpdateServicePipelineCommandOutput | UpdateServiceTemplateCommandOutput | UpdateServiceTemplateVersionCommandOutput | UpdateTemplateSyncConfigCommandOutput;
|
|
88
89
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
89
90
|
/**
|
|
90
91
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -198,46 +199,54 @@ declare type ProtonClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
|
|
|
198
199
|
export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigType {
|
|
199
200
|
}
|
|
200
201
|
/**
|
|
201
|
-
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
202
|
+
* <p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
203
|
+
* <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
|
|
204
|
+
* service.</p>
|
|
202
205
|
* <p>The documentation for each action shows the Query API request parameters and the XML response.</p>
|
|
203
|
-
* <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
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* <i>update</i>
|
|
206
|
+
* <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
|
|
207
|
+
* Guide</a>.</p>
|
|
208
|
+
* <p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide
|
|
209
|
+
* standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in
|
|
210
|
+
* turn, select from the available service templates to automate their application or service deployments.</p>
|
|
211
|
+
* <p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need
|
|
212
|
+
* permissions to use all of the listed API operations.</p>
|
|
213
|
+
* <p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To
|
|
214
|
+
* monitor their applications that are running on Proton, developers need permissions to the service
|
|
215
|
+
* <i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i>
|
|
216
|
+
* API operations and the service instance <i>list</i> and <i>update</i> API
|
|
217
|
+
* operations.</p>
|
|
213
218
|
* <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>
|
|
214
219
|
* <p>
|
|
215
220
|
* <b>Ensuring Idempotency</b>
|
|
216
221
|
* </p>
|
|
217
|
-
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
218
|
-
* Operations might also time out or encounter other server issues before they're
|
|
219
|
-
*
|
|
220
|
-
*
|
|
221
|
-
*
|
|
222
|
+
* <p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
223
|
+
* of the operation are complete. Operations might also time out or encounter other server issues before they're
|
|
224
|
+
* complete, even if the request already returned a result. This might make it difficult to determine whether the
|
|
225
|
+
* request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation
|
|
226
|
+
* completes successfully. However, if the original request and the subsequent retries are successful, the operation
|
|
227
|
+
* occurs multiple times. This means that you might create more resources than you intended.</p>
|
|
222
228
|
* <p>
|
|
223
|
-
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
224
|
-
* original request action completes successfully, any subsequent retries complete
|
|
225
|
-
* result might contain updated information, such as
|
|
229
|
+
* <i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
230
|
+
* idempotent request, if the original request action completes successfully, any subsequent retries complete
|
|
231
|
+
* successfully without performing any further actions. However, the result might contain updated information, such as
|
|
232
|
+
* the current creation status.</p>
|
|
226
233
|
* <p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
|
|
227
234
|
* <p>
|
|
228
235
|
* <b>Idempotent create APIs with a client token</b>
|
|
229
236
|
* </p>
|
|
230
|
-
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
231
|
-
* also support idempotency using a client token. A client token is a unique,
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
*
|
|
237
|
+
* <p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
238
|
+
* corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,
|
|
239
|
+
* case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,
|
|
240
|
+
* specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token
|
|
241
|
+
* for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically
|
|
242
|
+
* provided by SDKs.</p>
|
|
235
243
|
* <p>Given a request action that has succeeded:</p>
|
|
236
|
-
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
237
|
-
* than returning the original resource detail data in the response.</p>
|
|
238
|
-
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
239
|
-
*
|
|
240
|
-
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
244
|
+
* <p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
245
|
+
* performing any further actions other than returning the original resource detail data in the response.</p>
|
|
246
|
+
* <p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
247
|
+
* throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
|
|
248
|
+
* <p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
249
|
+
* resource is created.</p>
|
|
241
250
|
* <p>If the original resource is deleted and you retry the request, a new resource is created.</p>
|
|
242
251
|
* <p>Idempotent create APIs with a client token:</p>
|
|
243
252
|
* <ul>
|
|
@@ -255,8 +264,9 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
|
|
|
255
264
|
* <b>Idempotent create APIs</b>
|
|
256
265
|
* </p>
|
|
257
266
|
* <p>Given a request action that has succeeded:</p>
|
|
258
|
-
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
259
|
-
* without performing any further actions other than returning the original resource detail
|
|
267
|
+
* <p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
268
|
+
* modified, the retry succeeds without performing any further actions other than returning the original resource detail
|
|
269
|
+
* data in the response.</p>
|
|
260
270
|
* <p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
|
|
261
271
|
* <p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
|
|
262
272
|
* <code>IdempotentParameterMismatch</code> error.</p>
|
|
@@ -279,7 +289,8 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
|
|
|
279
289
|
* <b>Idempotent delete APIs</b>
|
|
280
290
|
* </p>
|
|
281
291
|
* <p>Given a request action that has succeeded:</p>
|
|
282
|
-
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
292
|
+
* <p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
293
|
+
* the response.</p>
|
|
283
294
|
* <p>If you retry and the resource doesn't exist, the response is empty.</p>
|
|
284
295
|
* <p>In both cases, the retry succeeds.</p>
|
|
285
296
|
* <p>Idempotent delete APIs:</p>
|
|
@@ -304,8 +315,9 @@ export interface ProtonClientResolvedConfig extends ProtonClientResolvedConfigTy
|
|
|
304
315
|
* <b>Asynchronous idempotent delete APIs</b>
|
|
305
316
|
* </p>
|
|
306
317
|
* <p>Given a request action that has succeeded:</p>
|
|
307
|
-
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
308
|
-
*
|
|
318
|
+
* <p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
319
|
+
* <code>DELETE_IN_PROGRESS</code>, the retry returns the resource detail data in the response without performing any
|
|
320
|
+
* further actions.</p>
|
|
309
321
|
* <p>If the original request delete operation is complete, a retry returns an empty response.</p>
|
|
310
322
|
* <p>Asynchronous idempotent delete APIs:</p>
|
|
311
323
|
* <ul>
|
|
@@ -8,11 +8,12 @@ export interface CreateTemplateSyncConfigCommandInput extends CreateTemplateSync
|
|
|
8
8
|
export interface CreateTemplateSyncConfigCommandOutput extends CreateTemplateSyncConfigOutput, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Set up a template to create new template versions automatically by tracking a linked repository. A linked
|
|
12
|
-
*
|
|
13
|
-
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your repository template
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* <p>Set up a template to create new template versions automatically by tracking a linked repository. A linked
|
|
12
|
+
* repository is a repository that has been registered with Proton. For more information, see <a>CreateRepository</a>.</p>
|
|
13
|
+
* <p>When a commit is pushed to your linked repository, Proton checks for changes to your repository template
|
|
14
|
+
* bundles. If it detects a template bundle change, a new major or minor version of its template is created, if the
|
|
15
|
+
* 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
|
|
16
|
+
* <i>Proton User Guide</i>.</p>
|
|
16
17
|
* @example
|
|
17
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
19
|
* ```javascript
|