Skip to content

Commit 23aac72

Browse files
committed
docs(retries): add documentation for retry mechanisms
this adds documentation for the new retry mechanisms for public-offer update workflows and private-offer create.
1 parent c2113e1 commit 23aac72

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

docs/private-offer/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
How to create a private offer
22
=============================
33

4+
Retry behavior for change-set workflows
5+
--------------------------------------
6+
7+
Commands that submit Marketplace change sets now support retry options for transient contention failures.
8+
9+
Retry flags:
10+
11+
- ``--retry-max-retries`` (default: ``0``; retries are opt-in)
12+
- ``--retry-initial-delay-seconds`` (default: ``60``)
13+
- ``--retry-max-delay-seconds`` (default: ``300``)
14+
15+
Supported private-offer workflow:
16+
17+
- ``awsmp private-offer create``
18+
19+
Example:
20+
21+
.. code-block:: sh
22+
23+
awsmp private-offer create \
24+
--product-id 3a628887-30de-4d23-a949-93b32e4e4c5f \
25+
--buyer-accounts 887450378614 \
26+
--customer-name "toabctl testing" \
27+
--pricing prices.csv \
28+
--retry-max-retries 3 \
29+
--retry-initial-delay-seconds 60 \
30+
--retry-max-delay-seconds 300
31+
432
To create a private offer in the `AWS marketplace management portal`_, use the API calls described below.
533

634

docs/public-offer/index.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,43 @@
11
How to create a public offer
22
============================
33

4+
Retry behavior for change-set workflows
5+
--------------------------------------
6+
7+
Commands that submit Marketplace change sets now support retry options for transient contention failures such as:
8+
9+
- ``Requested change set has entities locked by change sets``
10+
- ``maximum service quota limit ... entities ... updated concurrently``
11+
12+
Retry flags:
13+
14+
- ``--retry-max-retries`` (default: ``0``; retries are opt-in)
15+
- ``--retry-initial-delay-seconds`` (default: ``60``)
16+
- ``--retry-max-delay-seconds`` (default: ``300``)
17+
18+
Supported public-offer workflows:
19+
20+
- ``awsmp public-offer create``
21+
- ``awsmp public-offer update-description``
22+
- ``awsmp public-offer update-instance-type``
23+
- ``awsmp public-offer update-region``
24+
- ``awsmp public-offer update-version``
25+
- ``awsmp public-offer update-legal-terms``
26+
- ``awsmp public-offer update-support-terms``
27+
- ``awsmp public-offer release``
28+
- ``awsmp public-offer update``
29+
30+
Example:
31+
32+
.. code-block:: sh
33+
34+
awsmp public-offer update \
35+
--product-id prod-fwu3xsqup23cs \
36+
--config listing_configuration.yaml \
37+
--retry-max-retries 3 \
38+
--retry-initial-delay-seconds 60 \
39+
--retry-max-delay-seconds 300
40+
441
To create a new public AMI product listing in the `AWS marketplace management portal`_, use the API calls described below:
542

643

0 commit comments

Comments
 (0)