feat(client-privatenetworks): This release allows Private5G customers…

… to choose different commitment plans (60-days, 1-year, 3-years) when placing new orders, enables automatic renewal option for 1-year and 3-years commitments. It also allows customers to update the commitment plan of an existing radio unit.
aws · Jun 27, 2023 · c0eca18 · c0eca18
1 parent bfd0e0c
commit c0eca18
Show file tree

Hide file tree

Showing 18 changed files with 687 additions and 222 deletions.
diff --git a/clients/client-privatenetworks/src/commands/AcknowledgeOrderReceiptCommand.ts b/clients/client-privatenetworks/src/commands/AcknowledgeOrderReceiptCommand.ts
@@ -66,6 +66,7 @@ export interface AcknowledgeOrderReceiptCommandOutput extends AcknowledgeOrderRe
  * //       street1: "STRING_VALUE", // required
  * //       street2: "STRING_VALUE",
  * //       street3: "STRING_VALUE",
+ * //       emailAddress: "STRING_VALUE",
  * //     },
  * //     networkArn: "STRING_VALUE",
  * //     networkSiteArn: "STRING_VALUE",
@@ -76,6 +77,16 @@ export interface AcknowledgeOrderReceiptCommandOutput extends AcknowledgeOrderRe
  * //     ],
  * //     acknowledgmentStatus: "STRING_VALUE",
  * //     createdAt: new Date("TIMESTAMP"),
+ * //     orderedResources: [ // OrderedResourceDefinitions
+ * //       { // OrderedResourceDefinition
+ * //         type: "STRING_VALUE", // required
+ * //         count: Number("int"), // required
+ * //         commitmentConfiguration: { // CommitmentConfiguration
+ * //           commitmentLength: "STRING_VALUE", // required
+ * //           automaticRenewal: true || false, // required
+ * //         },
+ * //       },
+ * //     ],
  * //   },
  * // };
  *

diff --git a/clients/client-privatenetworks/src/commands/ActivateNetworkSiteCommand.ts b/clients/client-privatenetworks/src/commands/ActivateNetworkSiteCommand.ts
@@ -60,8 +60,13 @@ export interface ActivateNetworkSiteCommandOutput extends ActivateNetworkSiteRes
  *     street1: "STRING_VALUE", // required
  *     street2: "STRING_VALUE",
  *     street3: "STRING_VALUE",
+ *     emailAddress: "STRING_VALUE",
  *   },
  *   clientToken: "STRING_VALUE",
+ *   commitmentConfiguration: { // CommitmentConfiguration
+ *     commitmentLength: "STRING_VALUE", // required
+ *     automaticRenewal: true || false, // required
+ *   },
  * };
  * const command = new ActivateNetworkSiteCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-privatenetworks/src/commands/ConfigureAccessPointCommand.ts b/clients/client-privatenetworks/src/commands/ConfigureAccessPointCommand.ts
@@ -41,14 +41,11 @@ export interface ConfigureAccessPointCommandOutput extends ConfigureAccessPointR
 
 /**
  * @public
- * <p>Configures the specified network resource.
- *         </p>
- *          <p>
- *             Use this action to specify the geographic
- *             position of the hardware. You must provide Certified Professional Installer (CPI)
- *             credentials in the request so that we can obtain spectrum grants. For more information,
- *             see <a href="https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html">Radio
- *                 units</a> in the <i>Amazon Web Services Private 5G User Guide</i>. </p>
+ * <p>Configures the specified network resource. </p>
+ *          <p> Use this action to specify the geographic position of the hardware. You must provide
+ *             Certified Professional Installer (CPI) credentials in the request so that we can obtain
+ *             spectrum grants. For more information, see <a href="https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html">Radio units</a> in the
+ *                     <i>Amazon Web Services Private 5G User Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -111,11 +108,20 @@ export interface ConfigureAccessPointCommandOutput extends ConfigureAccessPointR
  * //         street1: "STRING_VALUE", // required
  * //         street2: "STRING_VALUE",
  * //         street3: "STRING_VALUE",
+ * //         emailAddress: "STRING_VALUE",
  * //       },
  * //       returnReason: "STRING_VALUE",
  * //       replacementOrderArn: "STRING_VALUE",
  * //       shippingLabel: "STRING_VALUE",
  * //     },
+ * //     commitmentInformation: { // CommitmentInformation
+ * //       commitmentConfiguration: { // CommitmentConfiguration
+ * //         commitmentLength: "STRING_VALUE", // required
+ * //         automaticRenewal: true || false, // required
+ * //       },
+ * //       startAt: new Date("TIMESTAMP"),
+ * //       expiresOn: new Date("TIMESTAMP"),
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-privatenetworks/src/commands/DeleteNetworkCommand.ts b/clients/client-privatenetworks/src/commands/DeleteNetworkCommand.ts
@@ -37,9 +37,8 @@ export interface DeleteNetworkCommandOutput extends DeleteNetworkResponse, __Met
 /**
  * @public
  * <p>Deletes the specified network. You must delete network sites before you delete the
- *             network. For more information, see
- *             <a href="https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html">DeleteNetworkSite</a> in the
- *             <i>API Reference for Amazon Web Services Private 5G</i>.</p>
+ *             network. For more information, see <a href="https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html">DeleteNetworkSite</a> in the <i>API Reference for Amazon Web Services Private
+ *                 5G</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-privatenetworks/src/commands/GetNetworkResourceCommand.ts b/clients/client-privatenetworks/src/commands/GetNetworkResourceCommand.ts
@@ -92,11 +92,20 @@ export interface GetNetworkResourceCommandOutput extends GetNetworkResourceRespo
  * //         street1: "STRING_VALUE", // required
  * //         street2: "STRING_VALUE",
  * //         street3: "STRING_VALUE",
+ * //         emailAddress: "STRING_VALUE",
  * //       },
  * //       returnReason: "STRING_VALUE",
  * //       replacementOrderArn: "STRING_VALUE",
  * //       shippingLabel: "STRING_VALUE",
  * //     },
+ * //     commitmentInformation: { // CommitmentInformation
+ * //       commitmentConfiguration: { // CommitmentConfiguration
+ * //         commitmentLength: "STRING_VALUE", // required
+ * //         automaticRenewal: true || false, // required
+ * //       },
+ * //       startAt: new Date("TIMESTAMP"),
+ * //       expiresOn: new Date("TIMESTAMP"),
+ * //     },
  * //   },
  * //   tags: { // TagMap
  * //     "<keys>": "STRING_VALUE",

diff --git a/clients/client-privatenetworks/src/commands/GetOrderCommand.ts b/clients/client-privatenetworks/src/commands/GetOrderCommand.ts
@@ -62,6 +62,7 @@ export interface GetOrderCommandOutput extends GetOrderResponse, __MetadataBeare
  * //       street1: "STRING_VALUE", // required
  * //       street2: "STRING_VALUE",
  * //       street3: "STRING_VALUE",
+ * //       emailAddress: "STRING_VALUE",
  * //     },
  * //     networkArn: "STRING_VALUE",
  * //     networkSiteArn: "STRING_VALUE",
@@ -72,6 +73,16 @@ export interface GetOrderCommandOutput extends GetOrderResponse, __MetadataBeare
  * //     ],
  * //     acknowledgmentStatus: "STRING_VALUE",
  * //     createdAt: new Date("TIMESTAMP"),
+ * //     orderedResources: [ // OrderedResourceDefinitions
+ * //       { // OrderedResourceDefinition
+ * //         type: "STRING_VALUE", // required
+ * //         count: Number("int"), // required
+ * //         commitmentConfiguration: { // CommitmentConfiguration
+ * //           commitmentLength: "STRING_VALUE", // required
+ * //           automaticRenewal: true || false, // required
+ * //         },
+ * //       },
+ * //     ],
  * //   },
  * //   tags: { // TagMap
  * //     "<keys>": "STRING_VALUE",

diff --git a/clients/client-privatenetworks/src/commands/ListDeviceIdentifiersCommand.ts b/clients/client-privatenetworks/src/commands/ListDeviceIdentifiersCommand.ts
@@ -40,9 +40,9 @@ export interface ListDeviceIdentifiersCommandOutput extends ListDeviceIdentifier
 
 /**
  * @public
- * <p>Lists device identifiers. Add filters to your request to return a more
- *             specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order,
- *             the status of device identifiers, or the ARN of the traffic group.</p>
+ * <p>Lists device identifiers. Add filters to your request to return a more specific list
+ *             of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status
+ *             of device identifiers, or the ARN of the traffic group.</p>
  *          <p>If you specify multiple filters, filters are joined with an OR, and the request
  * returns results that match all of the specified filters.</p>
  * @example

diff --git a/clients/client-privatenetworks/src/commands/ListNetworkResourcesCommand.ts b/clients/client-privatenetworks/src/commands/ListNetworkResourcesCommand.ts
@@ -40,9 +40,9 @@ export interface ListNetworkResourcesCommandOutput extends ListNetworkResourcesR
 
 /**
  * @public
- * <p>Lists network resources.  Add filters to your request to return a more
- *             specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or
- *             the status of network resources.</p>
+ * <p>Lists network resources. Add filters to your request to return a more specific list of
+ *             results. Use filters to match the Amazon Resource Name (ARN) of an order or the status
+ *             of network resources.</p>
  *          <p>If you specify multiple filters, filters are joined with an OR, and the request
  * returns results that match all of the specified filters.</p>
  * @example
@@ -104,11 +104,20 @@ export interface ListNetworkResourcesCommandOutput extends ListNetworkResourcesR
  * //           street1: "STRING_VALUE", // required
  * //           street2: "STRING_VALUE",
  * //           street3: "STRING_VALUE",
+ * //           emailAddress: "STRING_VALUE",
  * //         },
  * //         returnReason: "STRING_VALUE",
  * //         replacementOrderArn: "STRING_VALUE",
  * //         shippingLabel: "STRING_VALUE",
  * //       },
+ * //       commitmentInformation: { // CommitmentInformation
+ * //         commitmentConfiguration: { // CommitmentConfiguration
+ * //           commitmentLength: "STRING_VALUE", // required
+ * //           automaticRenewal: true || false, // required
+ * //         },
+ * //         startAt: new Date("TIMESTAMP"),
+ * //         expiresOn: new Date("TIMESTAMP"),
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-privatenetworks/src/commands/ListNetworkSitesCommand.ts b/clients/client-privatenetworks/src/commands/ListNetworkSitesCommand.ts
@@ -36,8 +36,8 @@ export interface ListNetworkSitesCommandOutput extends ListNetworkSitesResponse,
 
 /**
  * @public
- * <p>Lists network sites. Add filters to your request to return a more
- *             specific list of results. Use filters to match the status of the network site.</p>
+ * <p>Lists network sites. Add filters to your request to return a more specific list of
+ *             results. Use filters to match the status of the network site.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-privatenetworks/src/commands/ListNetworksCommand.ts b/clients/client-privatenetworks/src/commands/ListNetworksCommand.ts
@@ -36,8 +36,8 @@ export interface ListNetworksCommandOutput extends ListNetworksResponse, __Metad
 
 /**
  * @public
- * <p>Lists networks. Add filters to your request to return a more
- *             specific list of results. Use filters to match the status of the network.</p>
+ * <p>Lists networks. Add filters to your request to return a more specific list of results.
+ *             Use filters to match the status of the network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-privatenetworks/src/commands/ListOrdersCommand.ts b/clients/client-privatenetworks/src/commands/ListOrdersCommand.ts
@@ -36,9 +36,9 @@ export interface ListOrdersCommandOutput extends ListOrdersResponse, __MetadataB
 
 /**
  * @public
- * <p>Lists orders.  Add filters to your request to return a more
- *             specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or
- *             the status of the order.</p>
+ * <p>Lists orders. Add filters to your request to return a more specific list of results.
+ *             Use filters to match the Amazon Resource Name (ARN) of the network site or the status of
+ *             the order.</p>
  *          <p>If you specify multiple filters, filters are joined with an OR, and the request
  * returns results that match all of the specified filters.</p>
  * @example
@@ -74,6 +74,7 @@ export interface ListOrdersCommandOutput extends ListOrdersResponse, __MetadataB
  * //         street1: "STRING_VALUE", // required
  * //         street2: "STRING_VALUE",
  * //         street3: "STRING_VALUE",
+ * //         emailAddress: "STRING_VALUE",
  * //       },
  * //       networkArn: "STRING_VALUE",
  * //       networkSiteArn: "STRING_VALUE",
@@ -84,6 +85,16 @@ export interface ListOrdersCommandOutput extends ListOrdersResponse, __MetadataB
  * //       ],
  * //       acknowledgmentStatus: "STRING_VALUE",
  * //       createdAt: new Date("TIMESTAMP"),
+ * //       orderedResources: [ // OrderedResourceDefinitions
+ * //         { // OrderedResourceDefinition
+ * //           type: "STRING_VALUE", // required
+ * //           count: Number("int"), // required
+ * //           commitmentConfiguration: { // CommitmentConfiguration
+ * //             commitmentLength: "STRING_VALUE", // required
+ * //             automaticRenewal: true || false, // required
+ * //           },
+ * //         },
+ * //       ],
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-privatenetworks/src/commands/ListTagsForResourceCommand.ts b/clients/client-privatenetworks/src/commands/ListTagsForResourceCommand.ts
@@ -76,9 +76,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  *  <p>The resource was not found.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>
- *             The request was denied due to request throttling.
- *         </p>
+ *  <p> The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request failed validation.</p>

diff --git a/clients/client-privatenetworks/src/commands/StartNetworkResourceUpdateCommand.ts b/clients/client-privatenetworks/src/commands/StartNetworkResourceUpdateCommand.ts
@@ -41,12 +41,24 @@ export interface StartNetworkResourceUpdateCommandOutput extends StartNetworkRes
 
 /**
  * @public
- * <p>Starts an update of the specified network resource.</p>
- *          <p>After you submit a request to replace or return a network resource, the status
- *            of the network resource is <code>CREATING_SHIPPING_LABEL</code>. The shipping label
- *             is available when the status of the network resource is <code>PENDING_RETURN</code>.
- *             After the network resource is successfully returned, its status is <code>DELETED</code>.
- *             For more information, see <a href="https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit">Return a radio unit</a>.</p>
+ * <p>Use this action to do the following tasks:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Update the duration and renewal status of the commitment period for a radio
+ *                     unit. The update goes into effect immediately.</p>
+ *             </li>
+ *             <li>
+ *                <p>Request a replacement for a network resource.</p>
+ *             </li>
+ *             <li>
+ *                <p>Request that you return a network resource.</p>
+ *             </li>
+ *          </ul>
+ *          <p>After you submit a request to replace or return a network resource, the status of the
+ *             network resource changes to <code>CREATING_SHIPPING_LABEL</code>. The shipping label is
+ *             available when the status of the network resource is <code>PENDING_RETURN</code>. After
+ *             the network resource is successfully returned, its status changes to
+ *                 <code>DELETED</code>. For more information, see <a href="https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit">Return a radio unit</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -67,8 +79,13 @@ export interface StartNetworkResourceUpdateCommandOutput extends StartNetworkRes
  *     street1: "STRING_VALUE", // required
  *     street2: "STRING_VALUE",
  *     street3: "STRING_VALUE",
+ *     emailAddress: "STRING_VALUE",
  *   },
  *   returnReason: "STRING_VALUE",
+ *   commitmentConfiguration: { // CommitmentConfiguration
+ *     commitmentLength: "STRING_VALUE", // required
+ *     automaticRenewal: true || false, // required
+ *   },
  * };
  * const command = new StartNetworkResourceUpdateCommand(input);
  * const response = await client.send(command);
@@ -112,11 +129,20 @@ export interface StartNetworkResourceUpdateCommandOutput extends StartNetworkRes
  * //         street1: "STRING_VALUE", // required
  * //         street2: "STRING_VALUE",
  * //         street3: "STRING_VALUE",
+ * //         emailAddress: "STRING_VALUE",
  * //       },
  * //       returnReason: "STRING_VALUE",
  * //       replacementOrderArn: "STRING_VALUE",
  * //       shippingLabel: "STRING_VALUE",
  * //     },
+ * //     commitmentInformation: { // CommitmentInformation
+ * //       commitmentConfiguration: { // CommitmentConfiguration
+ * //         commitmentLength: "STRING_VALUE", // required
+ * //         automaticRenewal: true || false, // required
+ * //       },
+ * //       startAt: new Date("TIMESTAMP"),
+ * //       expiresOn: new Date("TIMESTAMP"),
+ * //     },
  * //   },
  * // };
  *

diff --git a/clients/client-privatenetworks/src/commands/TagResourceCommand.ts b/clients/client-privatenetworks/src/commands/TagResourceCommand.ts
@@ -36,9 +36,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 
 /**
  * @public
- * <p>
- *             Adds tags to the specified resource.
- *         </p>
+ * <p> Adds tags to the specified resource. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -73,9 +71,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  *  <p>The resource was not found.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>
- *             The request was denied due to request throttling.
- *         </p>
+ *  <p> The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request failed validation.</p>

diff --git a/clients/client-privatenetworks/src/commands/UntagResourceCommand.ts b/clients/client-privatenetworks/src/commands/UntagResourceCommand.ts
@@ -75,9 +75,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  *  <p>The resource was not found.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>
- *             The request was denied due to request throttling.
- *         </p>
+ *  <p> The request was denied due to request throttling. </p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>The request failed validation.</p>