Skip to content

Commit c0eca18

Browse files
author
awstools
committed
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.
1 parent bfd0e0c commit c0eca18

18 files changed

+687
-222
lines changed

clients/client-privatenetworks/src/commands/AcknowledgeOrderReceiptCommand.ts

+11
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export interface AcknowledgeOrderReceiptCommandOutput extends AcknowledgeOrderRe
6666
* // street1: "STRING_VALUE", // required
6767
* // street2: "STRING_VALUE",
6868
* // street3: "STRING_VALUE",
69+
* // emailAddress: "STRING_VALUE",
6970
* // },
7071
* // networkArn: "STRING_VALUE",
7172
* // networkSiteArn: "STRING_VALUE",
@@ -76,6 +77,16 @@ export interface AcknowledgeOrderReceiptCommandOutput extends AcknowledgeOrderRe
7677
* // ],
7778
* // acknowledgmentStatus: "STRING_VALUE",
7879
* // createdAt: new Date("TIMESTAMP"),
80+
* // orderedResources: [ // OrderedResourceDefinitions
81+
* // { // OrderedResourceDefinition
82+
* // type: "STRING_VALUE", // required
83+
* // count: Number("int"), // required
84+
* // commitmentConfiguration: { // CommitmentConfiguration
85+
* // commitmentLength: "STRING_VALUE", // required
86+
* // automaticRenewal: true || false, // required
87+
* // },
88+
* // },
89+
* // ],
7990
* // },
8091
* // };
8192
*

clients/client-privatenetworks/src/commands/ActivateNetworkSiteCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,13 @@ export interface ActivateNetworkSiteCommandOutput extends ActivateNetworkSiteRes
6060
* street1: "STRING_VALUE", // required
6161
* street2: "STRING_VALUE",
6262
* street3: "STRING_VALUE",
63+
* emailAddress: "STRING_VALUE",
6364
* },
6465
* clientToken: "STRING_VALUE",
66+
* commitmentConfiguration: { // CommitmentConfiguration
67+
* commitmentLength: "STRING_VALUE", // required
68+
* automaticRenewal: true || false, // required
69+
* },
6570
* };
6671
* const command = new ActivateNetworkSiteCommand(input);
6772
* const response = await client.send(command);

clients/client-privatenetworks/src/commands/ConfigureAccessPointCommand.ts

+14-8
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,11 @@ export interface ConfigureAccessPointCommandOutput extends ConfigureAccessPointR
4141

4242
/**
4343
* @public
44-
* <p>Configures the specified network resource.
45-
* </p>
46-
* <p>
47-
* Use this action to specify the geographic
48-
* position of the hardware. You must provide Certified Professional Installer (CPI)
49-
* credentials in the request so that we can obtain spectrum grants. For more information,
50-
* see <a href="https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html">Radio
51-
* units</a> in the <i>Amazon Web Services Private 5G User Guide</i>. </p>
44+
* <p>Configures the specified network resource. </p>
45+
* <p> Use this action to specify the geographic position of the hardware. You must provide
46+
* Certified Professional Installer (CPI) credentials in the request so that we can obtain
47+
* 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
48+
* <i>Amazon Web Services Private 5G User Guide</i>. </p>
5249
* @example
5350
* Use a bare-bones client and the command you need to make an API call.
5451
* ```javascript
@@ -111,11 +108,20 @@ export interface ConfigureAccessPointCommandOutput extends ConfigureAccessPointR
111108
* // street1: "STRING_VALUE", // required
112109
* // street2: "STRING_VALUE",
113110
* // street3: "STRING_VALUE",
111+
* // emailAddress: "STRING_VALUE",
114112
* // },
115113
* // returnReason: "STRING_VALUE",
116114
* // replacementOrderArn: "STRING_VALUE",
117115
* // shippingLabel: "STRING_VALUE",
118116
* // },
117+
* // commitmentInformation: { // CommitmentInformation
118+
* // commitmentConfiguration: { // CommitmentConfiguration
119+
* // commitmentLength: "STRING_VALUE", // required
120+
* // automaticRenewal: true || false, // required
121+
* // },
122+
* // startAt: new Date("TIMESTAMP"),
123+
* // expiresOn: new Date("TIMESTAMP"),
124+
* // },
119125
* // },
120126
* // };
121127
*

clients/client-privatenetworks/src/commands/DeleteNetworkCommand.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ export interface DeleteNetworkCommandOutput extends DeleteNetworkResponse, __Met
3737
/**
3838
* @public
3939
* <p>Deletes the specified network. You must delete network sites before you delete the
40-
* network. For more information, see
41-
* <a href="https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html">DeleteNetworkSite</a> in the
42-
* <i>API Reference for Amazon Web Services Private 5G</i>.</p>
40+
* 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
41+
* 5G</i>.</p>
4342
* @example
4443
* Use a bare-bones client and the command you need to make an API call.
4544
* ```javascript

clients/client-privatenetworks/src/commands/GetNetworkResourceCommand.ts

+9
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,20 @@ export interface GetNetworkResourceCommandOutput extends GetNetworkResourceRespo
9292
* // street1: "STRING_VALUE", // required
9393
* // street2: "STRING_VALUE",
9494
* // street3: "STRING_VALUE",
95+
* // emailAddress: "STRING_VALUE",
9596
* // },
9697
* // returnReason: "STRING_VALUE",
9798
* // replacementOrderArn: "STRING_VALUE",
9899
* // shippingLabel: "STRING_VALUE",
99100
* // },
101+
* // commitmentInformation: { // CommitmentInformation
102+
* // commitmentConfiguration: { // CommitmentConfiguration
103+
* // commitmentLength: "STRING_VALUE", // required
104+
* // automaticRenewal: true || false, // required
105+
* // },
106+
* // startAt: new Date("TIMESTAMP"),
107+
* // expiresOn: new Date("TIMESTAMP"),
108+
* // },
100109
* // },
101110
* // tags: { // TagMap
102111
* // "<keys>": "STRING_VALUE",

clients/client-privatenetworks/src/commands/GetOrderCommand.ts

+11
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ export interface GetOrderCommandOutput extends GetOrderResponse, __MetadataBeare
6262
* // street1: "STRING_VALUE", // required
6363
* // street2: "STRING_VALUE",
6464
* // street3: "STRING_VALUE",
65+
* // emailAddress: "STRING_VALUE",
6566
* // },
6667
* // networkArn: "STRING_VALUE",
6768
* // networkSiteArn: "STRING_VALUE",
@@ -72,6 +73,16 @@ export interface GetOrderCommandOutput extends GetOrderResponse, __MetadataBeare
7273
* // ],
7374
* // acknowledgmentStatus: "STRING_VALUE",
7475
* // createdAt: new Date("TIMESTAMP"),
76+
* // orderedResources: [ // OrderedResourceDefinitions
77+
* // { // OrderedResourceDefinition
78+
* // type: "STRING_VALUE", // required
79+
* // count: Number("int"), // required
80+
* // commitmentConfiguration: { // CommitmentConfiguration
81+
* // commitmentLength: "STRING_VALUE", // required
82+
* // automaticRenewal: true || false, // required
83+
* // },
84+
* // },
85+
* // ],
7586
* // },
7687
* // tags: { // TagMap
7788
* // "<keys>": "STRING_VALUE",

clients/client-privatenetworks/src/commands/ListDeviceIdentifiersCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ export interface ListDeviceIdentifiersCommandOutput extends ListDeviceIdentifier
4040

4141
/**
4242
* @public
43-
* <p>Lists device identifiers. Add filters to your request to return a more
44-
* specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order,
45-
* the status of device identifiers, or the ARN of the traffic group.</p>
43+
* <p>Lists device identifiers. Add filters to your request to return a more specific list
44+
* of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status
45+
* of device identifiers, or the ARN of the traffic group.</p>
4646
* <p>If you specify multiple filters, filters are joined with an OR, and the request
4747
* returns results that match all of the specified filters.</p>
4848
* @example

clients/client-privatenetworks/src/commands/ListNetworkResourcesCommand.ts

+12-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ export interface ListNetworkResourcesCommandOutput extends ListNetworkResourcesR
4040

4141
/**
4242
* @public
43-
* <p>Lists network resources. Add filters to your request to return a more
44-
* specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or
45-
* the status of network resources.</p>
43+
* <p>Lists network resources. Add filters to your request to return a more specific list of
44+
* results. Use filters to match the Amazon Resource Name (ARN) of an order or the status
45+
* of network resources.</p>
4646
* <p>If you specify multiple filters, filters are joined with an OR, and the request
4747
* returns results that match all of the specified filters.</p>
4848
* @example
@@ -104,11 +104,20 @@ export interface ListNetworkResourcesCommandOutput extends ListNetworkResourcesR
104104
* // street1: "STRING_VALUE", // required
105105
* // street2: "STRING_VALUE",
106106
* // street3: "STRING_VALUE",
107+
* // emailAddress: "STRING_VALUE",
107108
* // },
108109
* // returnReason: "STRING_VALUE",
109110
* // replacementOrderArn: "STRING_VALUE",
110111
* // shippingLabel: "STRING_VALUE",
111112
* // },
113+
* // commitmentInformation: { // CommitmentInformation
114+
* // commitmentConfiguration: { // CommitmentConfiguration
115+
* // commitmentLength: "STRING_VALUE", // required
116+
* // automaticRenewal: true || false, // required
117+
* // },
118+
* // startAt: new Date("TIMESTAMP"),
119+
* // expiresOn: new Date("TIMESTAMP"),
120+
* // },
112121
* // },
113122
* // ],
114123
* // nextToken: "STRING_VALUE",

clients/client-privatenetworks/src/commands/ListNetworkSitesCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface ListNetworkSitesCommandOutput extends ListNetworkSitesResponse,
3636

3737
/**
3838
* @public
39-
* <p>Lists network sites. Add filters to your request to return a more
40-
* specific list of results. Use filters to match the status of the network site.</p>
39+
* <p>Lists network sites. Add filters to your request to return a more specific list of
40+
* results. Use filters to match the status of the network site.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

clients/client-privatenetworks/src/commands/ListNetworksCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface ListNetworksCommandOutput extends ListNetworksResponse, __Metad
3636

3737
/**
3838
* @public
39-
* <p>Lists networks. Add filters to your request to return a more
40-
* specific list of results. Use filters to match the status of the network.</p>
39+
* <p>Lists networks. Add filters to your request to return a more specific list of results.
40+
* Use filters to match the status of the network.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript

clients/client-privatenetworks/src/commands/ListOrdersCommand.ts

+14-3
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ export interface ListOrdersCommandOutput extends ListOrdersResponse, __MetadataB
3636

3737
/**
3838
* @public
39-
* <p>Lists orders. Add filters to your request to return a more
40-
* specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or
41-
* the status of the order.</p>
39+
* <p>Lists orders. Add filters to your request to return a more specific list of results.
40+
* Use filters to match the Amazon Resource Name (ARN) of the network site or the status of
41+
* the order.</p>
4242
* <p>If you specify multiple filters, filters are joined with an OR, and the request
4343
* returns results that match all of the specified filters.</p>
4444
* @example
@@ -74,6 +74,7 @@ export interface ListOrdersCommandOutput extends ListOrdersResponse, __MetadataB
7474
* // street1: "STRING_VALUE", // required
7575
* // street2: "STRING_VALUE",
7676
* // street3: "STRING_VALUE",
77+
* // emailAddress: "STRING_VALUE",
7778
* // },
7879
* // networkArn: "STRING_VALUE",
7980
* // networkSiteArn: "STRING_VALUE",
@@ -84,6 +85,16 @@ export interface ListOrdersCommandOutput extends ListOrdersResponse, __MetadataB
8485
* // ],
8586
* // acknowledgmentStatus: "STRING_VALUE",
8687
* // createdAt: new Date("TIMESTAMP"),
88+
* // orderedResources: [ // OrderedResourceDefinitions
89+
* // { // OrderedResourceDefinition
90+
* // type: "STRING_VALUE", // required
91+
* // count: Number("int"), // required
92+
* // commitmentConfiguration: { // CommitmentConfiguration
93+
* // commitmentLength: "STRING_VALUE", // required
94+
* // automaticRenewal: true || false, // required
95+
* // },
96+
* // },
97+
* // ],
8798
* // },
8899
* // ],
89100
* // nextToken: "STRING_VALUE",

clients/client-privatenetworks/src/commands/ListTagsForResourceCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
7676
* <p>The resource was not found.</p>
7777
*
7878
* @throws {@link ThrottlingException} (client fault)
79-
* <p>
80-
* The request was denied due to request throttling.
81-
* </p>
79+
* <p> The request was denied due to request throttling. </p>
8280
*
8381
* @throws {@link ValidationException} (client fault)
8482
* <p>The request failed validation.</p>

clients/client-privatenetworks/src/commands/StartNetworkResourceUpdateCommand.ts

+32-6
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,24 @@ export interface StartNetworkResourceUpdateCommandOutput extends StartNetworkRes
4141

4242
/**
4343
* @public
44-
* <p>Starts an update of the specified network resource.</p>
45-
* <p>After you submit a request to replace or return a network resource, the status
46-
* of the network resource is <code>CREATING_SHIPPING_LABEL</code>. The shipping label
47-
* is available when the status of the network resource is <code>PENDING_RETURN</code>.
48-
* After the network resource is successfully returned, its status is <code>DELETED</code>.
49-
* 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>
44+
* <p>Use this action to do the following tasks:</p>
45+
* <ul>
46+
* <li>
47+
* <p>Update the duration and renewal status of the commitment period for a radio
48+
* unit. The update goes into effect immediately.</p>
49+
* </li>
50+
* <li>
51+
* <p>Request a replacement for a network resource.</p>
52+
* </li>
53+
* <li>
54+
* <p>Request that you return a network resource.</p>
55+
* </li>
56+
* </ul>
57+
* <p>After you submit a request to replace or return a network resource, the status of the
58+
* network resource changes to <code>CREATING_SHIPPING_LABEL</code>. The shipping label is
59+
* available when the status of the network resource is <code>PENDING_RETURN</code>. After
60+
* the network resource is successfully returned, its status changes to
61+
* <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>
5062
* @example
5163
* Use a bare-bones client and the command you need to make an API call.
5264
* ```javascript
@@ -67,8 +79,13 @@ export interface StartNetworkResourceUpdateCommandOutput extends StartNetworkRes
6779
* street1: "STRING_VALUE", // required
6880
* street2: "STRING_VALUE",
6981
* street3: "STRING_VALUE",
82+
* emailAddress: "STRING_VALUE",
7083
* },
7184
* returnReason: "STRING_VALUE",
85+
* commitmentConfiguration: { // CommitmentConfiguration
86+
* commitmentLength: "STRING_VALUE", // required
87+
* automaticRenewal: true || false, // required
88+
* },
7289
* };
7390
* const command = new StartNetworkResourceUpdateCommand(input);
7491
* const response = await client.send(command);
@@ -112,11 +129,20 @@ export interface StartNetworkResourceUpdateCommandOutput extends StartNetworkRes
112129
* // street1: "STRING_VALUE", // required
113130
* // street2: "STRING_VALUE",
114131
* // street3: "STRING_VALUE",
132+
* // emailAddress: "STRING_VALUE",
115133
* // },
116134
* // returnReason: "STRING_VALUE",
117135
* // replacementOrderArn: "STRING_VALUE",
118136
* // shippingLabel: "STRING_VALUE",
119137
* // },
138+
* // commitmentInformation: { // CommitmentInformation
139+
* // commitmentConfiguration: { // CommitmentConfiguration
140+
* // commitmentLength: "STRING_VALUE", // required
141+
* // automaticRenewal: true || false, // required
142+
* // },
143+
* // startAt: new Date("TIMESTAMP"),
144+
* // expiresOn: new Date("TIMESTAMP"),
145+
* // },
120146
* // },
121147
* // };
122148
*

clients/client-privatenetworks/src/commands/TagResourceCommand.ts

+2-6
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
3636

3737
/**
3838
* @public
39-
* <p>
40-
* Adds tags to the specified resource.
41-
* </p>
39+
* <p> Adds tags to the specified resource. </p>
4240
* @example
4341
* Use a bare-bones client and the command you need to make an API call.
4442
* ```javascript
@@ -73,9 +71,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
7371
* <p>The resource was not found.</p>
7472
*
7573
* @throws {@link ThrottlingException} (client fault)
76-
* <p>
77-
* The request was denied due to request throttling.
78-
* </p>
74+
* <p> The request was denied due to request throttling. </p>
7975
*
8076
* @throws {@link ValidationException} (client fault)
8177
* <p>The request failed validation.</p>

clients/client-privatenetworks/src/commands/UntagResourceCommand.ts

+1-3
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
7575
* <p>The resource was not found.</p>
7676
*
7777
* @throws {@link ThrottlingException} (client fault)
78-
* <p>
79-
* The request was denied due to request throttling.
80-
* </p>
78+
* <p> The request was denied due to request throttling. </p>
8179
*
8280
* @throws {@link ValidationException} (client fault)
8381
* <p>The request failed validation.</p>

0 commit comments

Comments
 (0)