You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-proton/README.md
+36-46Lines changed: 36 additions & 46 deletions
Original file line number
Diff line number
Diff line change
@@ -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
-
<ahref="https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html">actions</a> and <ahref="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 <ahref="https://docs.aws.amazon.com/proton/latest/APIReference/API_Operations.html">actions</a> and <ahref="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 <ahref="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">Amazon Web Services Command Line Interface User
15
-
Guide</a>.</p>
16
-
<p>The Proton service is a two-pronged automation framework. Administrators create service templates to provide
17
-
standardized infrastructure and deployment tooling for serverless and container based applications. Developers, in
18
-
turn, select from the available service templates to automate their application or service deployments.</p>
19
-
<p>Because administrators define the infrastructure and tooling that Proton deploys and manages, they need
20
-
permissions to use all of the listed API operations.</p>
21
-
<p>When developers select a specific infrastructure and tooling set, Proton deploys their applications. To
22
-
monitor their applications that are running on Proton, developers need permissions to the service
23
-
<i>create</i>, <i>list</i>, <i>update</i> and <i>delete</i>
24
-
API operations and the service instance <i>list</i> and <i>update</i> API
25
-
operations.</p>
26
-
<p>To learn more about Proton administration, see the <ahref="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 <ahref="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 <ahref="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 <ahref="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
-
of the operation are complete. Operations might also time out or encounter other server issues before they're
33
-
complete, even if the request already returned a result. This might make it difficult to determine whether the
34
-
request succeeded. Moreover, you might need to retry the request multiple times to ensure that the operation
35
-
completes successfully. However, if the original request and the subsequent retries are successful, the operation
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
-
idempotent request, if the original request action completes successfully, any subsequent retries complete
40
-
successfully without performing any further actions. However, the result might contain updated information, such as
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
-
corresponding Amazon Web Services CLI commands also support idempotency using a client token. A client token is a unique,
48
-
case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions,
49
-
specify a client token in the request. We recommend that you <i>don't</i> reuse the same client token
50
-
for other API requests. If you don’t provide a client token for these APIs, a default client token is automatically
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
-
performing any further actions other than returning the original resource detail data in the response.</p>
55
-
<p>If you retry the request using the same client token, but one or more of the parameters are different, the retry
56
-
throws a <code>ValidationException</code> with an <code>IdempotentParameterMismatch</code> error.</p>
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
-
modified, the retry succeeds without performing any further actions other than returning the original resource detail
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
0 commit comments