@aws-sdk/client-proton 3.58.0 → 3.63.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/README.md +36 -46
- package/dist-cjs/protocols/Aws_json1_0.js +1 -0
- package/dist-es/protocols/Aws_json1_0.js +1 -1
- package/dist-types/Proton.d.ts +153 -162
- package/dist-types/ProtonClient.d.ts +36 -46
- package/dist-types/commands/AcceptEnvironmentAccountConnectionCommand.d.ts +3 -3
- package/dist-types/commands/CancelEnvironmentDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CancelServiceInstanceDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CancelServicePipelineDeploymentCommand.d.ts +4 -4
- package/dist-types/commands/CreateEnvironmentAccountConnectionCommand.d.ts +5 -5
- package/dist-types/commands/CreateEnvironmentCommand.d.ts +7 -8
- package/dist-types/commands/CreateEnvironmentTemplateCommand.d.ts +5 -4
- package/dist-types/commands/CreateEnvironmentTemplateVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateRepositoryCommand.d.ts +5 -3
- package/dist-types/commands/CreateServiceCommand.d.ts +4 -4
- package/dist-types/commands/CreateServiceTemplateCommand.d.ts +5 -5
- package/dist-types/commands/CreateServiceTemplateVersionCommand.d.ts +2 -2
- package/dist-types/commands/CreateTemplateSyncConfigCommand.d.ts +3 -4
- package/dist-types/commands/DeleteEnvironmentAccountConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteEnvironmentTemplateVersionCommand.d.ts +4 -4
- package/dist-types/commands/DeleteServiceTemplateVersionCommand.d.ts +6 -6
- package/dist-types/commands/GetEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/GetRepositorySyncStatusCommand.d.ts +8 -1
- package/dist-types/commands/GetServiceInstanceCommand.d.ts +1 -2
- package/dist-types/commands/ListEnvironmentAccountConnectionsCommand.d.ts +1 -1
- package/dist-types/commands/NotifyResourceDeploymentStatusChangeCommand.d.ts +2 -7
- package/dist-types/commands/RejectEnvironmentAccountConnectionCommand.d.ts +4 -4
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEnvironmentAccountConnectionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateEnvironmentCommand.d.ts +19 -18
- package/dist-types/commands/UpdateServiceInstanceCommand.d.ts +5 -7
- package/dist-types/commands/UpdateServicePipelineCommand.d.ts +5 -7
- package/dist-types/models/models_0.d.ts +180 -227
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.63.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.62.0...v3.63.0) (2022-04-04)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Features
|
|
10
|
+
|
|
11
|
+
* **client-proton:** SDK release to support tagging for AWS Proton Repository resource ([19e9f72](https://github.com/aws/aws-sdk-js-v3/commit/19e9f72ab60539b87624019ba16921ce495a5d4f))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
# [3.58.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.57.0...v3.58.0) (2022-03-28)
|
|
7
18
|
|
|
8
19
|
**Note:** Version bump only for package @aws-sdk/client-proton
|
package/README.md
CHANGED
|
@@ -7,55 +7,48 @@
|
|
|
7
7
|
|
|
8
8
|
AWS SDK for JavaScript Proton Client for Node.js, Browser and React Native.
|
|
9
9
|
|
|
10
|
-
<p>This is the Proton Service API Reference. It provides descriptions, syntax and usage examples for each of the
|
|
11
|
-
<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
|
|
12
|
-
service.</p>
|
|
10
|
+
<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>
|
|
13
11
|
<p>The documentation for each action shows the Query API request parameters and the XML response.</p>
|
|
14
|
-
<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
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<i>
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
<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>
|
|
12
|
+
<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>
|
|
13
|
+
<p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide standardized infrastructure
|
|
14
|
+
and deployment tooling for serverless and container based applications. Developers, in turn, select from the available service templates to
|
|
15
|
+
automate their application or service deployments.</p>
|
|
16
|
+
<p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need permissions to use all of the
|
|
17
|
+
listed API operations.</p>
|
|
18
|
+
<p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To monitor their applications that are
|
|
19
|
+
running on Proton, developers need permissions to the service <i>create</i>, <i>list</i>,
|
|
20
|
+
<i>update</i> and <i>delete</i> API operations and the service instance <i>list</i> and
|
|
21
|
+
<i>update</i> API operations.</p>
|
|
22
|
+
<p>To learn more about Proton administration, see the <a href="https://docs.aws.amazon.com/proton/latest/adminguide/Welcome.html">Proton
|
|
23
|
+
Administrator Guide</a>.</p>
|
|
27
24
|
<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>
|
|
28
25
|
<p>
|
|
29
26
|
<b>Ensuring Idempotency</b>
|
|
30
27
|
</p>
|
|
31
|
-
<p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
occurs multiple times. This means that you might create more resources than you intended.</p>
|
|
28
|
+
<p>When you make a mutating API request, the request typically returns a result before the asynchronous workflows of the operation are complete.
|
|
29
|
+
Operations might also time out or encounter other server issues before they're complete, even if the request already returned a result. This might
|
|
30
|
+
make it difficult to determine whether the request succeeded. Moreover, you might need to retry the request multiple times to ensure that the
|
|
31
|
+
operation completes successfully. However, if the original request and the subsequent retries are successful, the operation occurs multiple times.
|
|
32
|
+
This means that you might create more resources than you intended.</p>
|
|
37
33
|
<p>
|
|
38
|
-
<i>Idempotency</i> ensures that an API request action completes no more than one time. With an
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
the current creation status.</p>
|
|
34
|
+
<i>Idempotency</i> ensures that an API request action completes no more than one time. With an idempotent request, if the
|
|
35
|
+
original request action completes successfully, any subsequent retries complete successfully without performing any further actions. However, the
|
|
36
|
+
result might contain updated information, such as the current creation status.</p>
|
|
42
37
|
<p>The following lists of APIs are grouped according to methods that ensure idempotency.</p>
|
|
43
38
|
<p>
|
|
44
39
|
<b>Idempotent create APIs with a client token</b>
|
|
45
40
|
</p>
|
|
46
|
-
<p>The API actions in this list support idempotency with the use of a <i>client token</i>. The
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
provided by SDKs.</p>
|
|
41
|
+
<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
|
|
42
|
+
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
|
|
43
|
+
idempotent API request using one of these actions, specify a client token in the request. We recommend that you <i>don't</i> reuse
|
|
44
|
+
the same client token for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically provided
|
|
45
|
+
by SDKs.</p>
|
|
52
46
|
<p>Given a request action that has succeeded:</p>
|
|
53
|
-
<p>If you retry the request using the same client token and the same parameters, the retry succeeds without
|
|
54
|
-
|
|
55
|
-
<p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
|
|
56
|
-
|
|
57
|
-
<p>Client tokens expire eight hours after a request is made. If you retry the request with the expired token, a new
|
|
58
|
-
resource is created.</p>
|
|
47
|
+
<p>If you retry the request using the same client token and the same parameters, the retry succeeds without performing any further actions other
|
|
48
|
+
than returning the original resource detail data in the response.</p>
|
|
49
|
+
<p>If you retry the request using the same client token, but one or more of the parameters are different, the retry throws a
|
|
50
|
+
<code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
|
|
51
|
+
<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>
|
|
59
52
|
<p>If the original resource is deleted and you retry the request, a new resource is created.</p>
|
|
60
53
|
<p>Idempotent create APIs with a client token:</p>
|
|
61
54
|
<ul>
|
|
@@ -73,9 +66,8 @@ resource is created.</p>
|
|
|
73
66
|
<b>Idempotent create APIs</b>
|
|
74
67
|
</p>
|
|
75
68
|
<p>Given a request action that has succeeded:</p>
|
|
76
|
-
<p>If you retry the request with an API from this group, and the original resource <i>hasn't</i> been
|
|
77
|
-
|
|
78
|
-
data in the response.</p>
|
|
69
|
+
<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
|
|
70
|
+
without performing any further actions other than returning the original resource detail data in the response.</p>
|
|
79
71
|
<p>If the original resource has been modified, the retry throws a <code>ConflictException</code>.</p>
|
|
80
72
|
<p>If you retry with different input parameters, the retry throws a <code>ValidationException</code> with an
|
|
81
73
|
<code>IdempotentParameterMismatch</code> error.</p>
|
|
@@ -98,8 +90,7 @@ data in the response.</p>
|
|
|
98
90
|
<b>Idempotent delete APIs</b>
|
|
99
91
|
</p>
|
|
100
92
|
<p>Given a request action that has succeeded:</p>
|
|
101
|
-
<p>When you retry the request with an API from this group and the resource was deleted, its metadata is returned in
|
|
102
|
-
the response.</p>
|
|
93
|
+
<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>
|
|
103
94
|
<p>If you retry and the resource doesn't exist, the response is empty.</p>
|
|
104
95
|
<p>In both cases, the retry succeeds.</p>
|
|
105
96
|
<p>Idempotent delete APIs:</p>
|
|
@@ -124,9 +115,8 @@ the response.</p>
|
|
|
124
115
|
<b>Asynchronous idempotent delete APIs</b>
|
|
125
116
|
</p>
|
|
126
117
|
<p>Given a request action that has succeeded:</p>
|
|
127
|
-
<p>If you retry the request with an API from this group, if the original request delete operation status is
|
|
128
|
-
|
|
129
|
-
further actions.</p>
|
|
118
|
+
<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
|
|
119
|
+
retry returns the resource detail data in the response without performing any further actions.</p>
|
|
130
120
|
<p>If the original request delete operation is complete, a retry returns an empty response.</p>
|
|
131
121
|
<p>Asynchronous idempotent delete APIs:</p>
|
|
132
122
|
<ul>
|
|
@@ -4170,6 +4170,7 @@ const serializeAws_json1_0CreateRepositoryInput = (input, context) => {
|
|
|
4170
4170
|
...(input.encryptionKey !== undefined && input.encryptionKey !== null && { encryptionKey: input.encryptionKey }),
|
|
4171
4171
|
...(input.name !== undefined && input.name !== null && { name: input.name }),
|
|
4172
4172
|
...(input.provider !== undefined && input.provider !== null && { provider: input.provider }),
|
|
4173
|
+
...(input.tags !== undefined && input.tags !== null && { tags: serializeAws_json1_0TagList(input.tags, context) }),
|
|
4173
4174
|
};
|
|
4174
4175
|
};
|
|
4175
4176
|
const serializeAws_json1_0CreateServiceInput = (input, context) => {
|
|
@@ -5428,7 +5428,7 @@ var serializeAws_json1_0CreateEnvironmentTemplateVersionInput = function (input,
|
|
|
5428
5428
|
input.source !== null && { source: serializeAws_json1_0TemplateVersionSourceInput(input.source, context) })), (input.tags !== undefined && input.tags !== null && { tags: serializeAws_json1_0TagList(input.tags, context) })), (input.templateName !== undefined && input.templateName !== null && { templateName: input.templateName }));
|
|
5429
5429
|
};
|
|
5430
5430
|
var serializeAws_json1_0CreateRepositoryInput = function (input, context) {
|
|
5431
|
-
return __assign(__assign(__assign(__assign({}, (input.connectionArn !== undefined && input.connectionArn !== null && { connectionArn: input.connectionArn })), (input.encryptionKey !== undefined && input.encryptionKey !== null && { encryptionKey: input.encryptionKey })), (input.name !== undefined && input.name !== null && { name: input.name })), (input.provider !== undefined && input.provider !== null && { provider: input.provider }));
|
|
5431
|
+
return __assign(__assign(__assign(__assign(__assign({}, (input.connectionArn !== undefined && input.connectionArn !== null && { connectionArn: input.connectionArn })), (input.encryptionKey !== undefined && input.encryptionKey !== null && { encryptionKey: input.encryptionKey })), (input.name !== undefined && input.name !== null && { name: input.name })), (input.provider !== undefined && input.provider !== null && { provider: input.provider })), (input.tags !== undefined && input.tags !== null && { tags: serializeAws_json1_0TagList(input.tags, context) }));
|
|
5432
5432
|
};
|
|
5433
5433
|
var serializeAws_json1_0CreateServiceInput = function (input, context) {
|
|
5434
5434
|
return __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, (input.branchName !== undefined && input.branchName !== null && { branchName: input.branchName })), (input.description !== undefined && input.description !== null && { description: input.description })), (input.name !== undefined && input.name !== null && { name: input.name })), (input.repositoryConnectionArn !== undefined &&
|