From c0eca1870e50b241c5357cd53f80b51898ee99f0 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 27 Jun 2023 18:25:31 +0000 Subject: [PATCH] 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. --- .../AcknowledgeOrderReceiptCommand.ts | 11 + .../commands/ActivateNetworkSiteCommand.ts | 5 + .../commands/ConfigureAccessPointCommand.ts | 22 +- .../src/commands/DeleteNetworkCommand.ts | 5 +- .../src/commands/GetNetworkResourceCommand.ts | 9 + .../src/commands/GetOrderCommand.ts | 11 + .../commands/ListDeviceIdentifiersCommand.ts | 6 +- .../commands/ListNetworkResourcesCommand.ts | 15 +- .../src/commands/ListNetworkSitesCommand.ts | 4 +- .../src/commands/ListNetworksCommand.ts | 4 +- .../src/commands/ListOrdersCommand.ts | 17 +- .../commands/ListTagsForResourceCommand.ts | 4 +- .../StartNetworkResourceUpdateCommand.ts | 38 +- .../src/commands/TagResourceCommand.ts | 8 +- .../src/commands/UntagResourceCommand.ts | 4 +- .../src/models/models_0.ts | 372 +++++++++++++----- .../src/protocols/Aws_restJson1.ts | 25 ++ .../aws-models/privatenetworks.json | 349 ++++++++++++---- 18 files changed, 687 insertions(+), 222 deletions(-) diff --git a/clients/client-privatenetworks/src/commands/AcknowledgeOrderReceiptCommand.ts b/clients/client-privatenetworks/src/commands/AcknowledgeOrderReceiptCommand.ts index 7f0e310f5e975..1bfe84416b898 100644 --- 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 index e7ad73eab4479..8c769fa13b5ca 100644 --- 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 index 2ebdbfe5bb7ce..0f68081df14e5 100644 --- 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 - *

Configures the specified network resource. - *

- *

- * 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 Radio - * units in the Amazon Web Services Private 5G User Guide.

+ *

Configures the specified network resource.

+ *

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 Radio units in the + * Amazon Web Services Private 5G User Guide.

* @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 index 909768a1d9798..db692f373eeba 100644 --- 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 *

Deletes the specified network. You must delete network sites before you delete the - * network. For more information, see - * DeleteNetworkSite in the - * API Reference for Amazon Web Services Private 5G.

+ * network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private + * 5G.

* @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 index 6b7641f292df0..1cf4260f9f121 100644 --- 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 * // "": "STRING_VALUE", diff --git a/clients/client-privatenetworks/src/commands/GetOrderCommand.ts b/clients/client-privatenetworks/src/commands/GetOrderCommand.ts index 91a840a57a3ff..a06da1dae98dc 100644 --- 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 * // "": "STRING_VALUE", diff --git a/clients/client-privatenetworks/src/commands/ListDeviceIdentifiersCommand.ts b/clients/client-privatenetworks/src/commands/ListDeviceIdentifiersCommand.ts index dbc4a86e0f378..d704474a969cd 100644 --- 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 - *

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.

+ *

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.

*

If you specify multiple filters, filters are joined with an OR, and the request * returns results that match all of the specified filters.

* @example diff --git a/clients/client-privatenetworks/src/commands/ListNetworkResourcesCommand.ts b/clients/client-privatenetworks/src/commands/ListNetworkResourcesCommand.ts index 14545b499c11f..4d0ac799a0aa1 100644 --- 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 - *

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.

+ *

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.

*

If you specify multiple filters, filters are joined with an OR, and the request * returns results that match all of the specified filters.

* @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 index 5b00e66ee6be8..dbfe5b37ce599 100644 --- 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 - *

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.

+ *

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.

* @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 index 90137313b1747..66b2f15acbd5d 100644 --- 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 - *

Lists networks. Add filters to your request to return a more - * specific list of results. Use filters to match the status of the network.

+ *

Lists networks. Add filters to your request to return a more specific list of results. + * Use filters to match the status of the network.

* @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 index 038292b9cd7d8..d7c3742dcf327 100644 --- 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 - *

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.

+ *

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.

*

If you specify multiple filters, filters are joined with an OR, and the request * returns results that match all of the specified filters.

* @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 index 596f5b8bc73e4..091776ee0b991 100644 --- 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 *

The resource was not found.

* * @throws {@link ThrottlingException} (client fault) - *

- * The request was denied due to request throttling. - *

+ *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The request failed validation.

diff --git a/clients/client-privatenetworks/src/commands/StartNetworkResourceUpdateCommand.ts b/clients/client-privatenetworks/src/commands/StartNetworkResourceUpdateCommand.ts index cdf3a87264669..62d9d54369fb3 100644 --- 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 - *

Starts an update of the specified network resource.

- *

After you submit a request to replace or return a network resource, the status - * of the network resource is CREATING_SHIPPING_LABEL. The shipping label - * is available when the status of the network resource is PENDING_RETURN. - * After the network resource is successfully returned, its status is DELETED. - * For more information, see Return a radio unit.

+ *

Use this action to do the following tasks:

+ *
    + *
  • + *

    Update the duration and renewal status of the commitment period for a radio + * unit. The update goes into effect immediately.

    + *
    • + *
  • + *

    Request a replacement for a network resource.

    + *
    • + *
  • + *

    Request that you return a network resource.

    + *
    • + *
+ *

After you submit a request to replace or return a network resource, the status of the + * network resource changes to CREATING_SHIPPING_LABEL. The shipping label is + * available when the status of the network resource is PENDING_RETURN. After + * the network resource is successfully returned, its status changes to + * DELETED. For more information, see Return a radio unit.

* @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 index d9cd327cf680f..301ff5e5b871b 100644 --- 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 - *

- * Adds tags to the specified resource. - *

+ *

Adds tags to the specified resource.

* @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 *

The resource was not found.

* * @throws {@link ThrottlingException} (client fault) - *

- * The request was denied due to request throttling. - *

+ *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The request failed validation.

diff --git a/clients/client-privatenetworks/src/commands/UntagResourceCommand.ts b/clients/client-privatenetworks/src/commands/UntagResourceCommand.ts index d6a3bb630fe3b..f5058ce4ad297 100644 --- 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 *

The resource was not found.

* * @throws {@link ThrottlingException} (client fault) - *

- * The request was denied due to request throttling. - *

+ *

The request was denied due to request throttling.

* * @throws {@link ValidationException} (client fault) *

The request failed validation.

diff --git a/clients/client-privatenetworks/src/models/models_0.ts b/clients/client-privatenetworks/src/models/models_0.ts index 351d6b40e4d05..44e1c212972ee 100644 --- a/clients/client-privatenetworks/src/models/models_0.ts +++ b/clients/client-privatenetworks/src/models/models_0.ts @@ -48,6 +48,100 @@ export const AcknowledgmentStatus = { */ export type AcknowledgmentStatus = (typeof AcknowledgmentStatus)[keyof typeof AcknowledgmentStatus]; +/** + * @public + * @enum + */ +export const CommitmentLength = { + ONE_YEAR: "ONE_YEAR", + SIXTY_DAYS: "SIXTY_DAYS", + THREE_YEARS: "THREE_YEARS", +} as const; + +/** + * @public + */ +export type CommitmentLength = (typeof CommitmentLength)[keyof typeof CommitmentLength]; + +/** + * @public + *

Determines the duration and renewal status of the commitment period for a radio + * unit.

+ *

For pricing, see Amazon Web Services Private 5G + * Pricing.

+ */ +export interface CommitmentConfiguration { + /** + *

The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year + * period.

+ */ + commitmentLength: CommitmentLength | string | undefined; + + /** + *

Determines whether the commitment period for a radio unit is set to automatically + * renew for an additional 1 year after your current commitment period expires.

+ *

Set to True, if you want your commitment period to automatically renew. + * Set to False if you do not want your commitment to automatically renew.

+ *

You can do the following:

+ *
    + *
  • + *

    Set a 1-year commitment to automatically renew for an additional 1 year. The + * hourly rate for the additional year will continue to be the same as your + * existing 1-year rate.

    + *
    • + *
  • + *

    Set a 3-year commitment to automatically renew for an additional 1 year. The + * hourly rate for the additional year will continue to be the same as your + * existing 3-year rate.

    + *
    • + *
  • + *

    Turn off a previously-enabled automatic renewal on a 1-year or 3-year + * commitment.

    + *
    • + *
+ *

You cannot use the automatic-renewal option for a 60-day + * commitment.

+ */ + automaticRenewal: boolean | undefined; +} + +/** + * @public + * @enum + */ +export const NetworkResourceDefinitionType = { + DEVICE_IDENTIFIER: "DEVICE_IDENTIFIER", + RADIO_UNIT: "RADIO_UNIT", +} as const; + +/** + * @public + */ +export type NetworkResourceDefinitionType = + (typeof NetworkResourceDefinitionType)[keyof typeof NetworkResourceDefinitionType]; + +/** + * @public + *

Details of the network resources in the order.

+ */ +export interface OrderedResourceDefinition { + /** + *

The type of network resource in the order.

+ */ + type: NetworkResourceDefinitionType | string | undefined; + + /** + *

The number of network resources in the order.

+ */ + count: number | undefined; + + /** + *

The duration and renewal status of the commitment period for each radio unit in the + * order. Does not show details if the resource type is DEVICE_IDENTIFIER.

+ */ + commitmentConfiguration?: CommitmentConfiguration; +} + /** * @public *

Information about an address.

@@ -74,7 +168,7 @@ export interface Address { name: string | undefined; /** - *

The phone number for this address.

+ *

The recipient's phone number.

*/ phoneNumber?: string; @@ -102,6 +196,11 @@ export interface Address { *

The third line of the street address.

*/ street3?: string; + + /** + *

The recipient's email address.

+ */ + emailAddress?: string; } /** @@ -154,6 +253,11 @@ export interface Order { *

The creation time of the order.

*/ createdAt?: Date; + + /** + *

A list of the network resources placed in the order.

+ */ + orderedResources?: OrderedResourceDefinition[]; } /** @@ -332,12 +436,14 @@ export interface DeviceIdentifier { deviceIdentifierArn?: string; /** - *

The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

+ *

The Amazon Resource Name (ARN) of the traffic group to which the device identifier + * belongs.

*/ trafficGroupArn?: string; /** - *

The Amazon Resource Name (ARN) of the network on which the device identifier appears.

+ *

The Amazon Resource Name (ARN) of the network on which the device identifier + * appears.

*/ networkArn?: string; @@ -362,7 +468,8 @@ export interface DeviceIdentifier { status?: DeviceIdentifierStatus | string; /** - *

The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

+ *

The Amazon Resource Name (ARN) of the order used to purchase the device + * identifier.

*/ orderArn?: string; @@ -382,9 +489,7 @@ export interface ActivateDeviceIdentifierResponse { deviceIdentifier: DeviceIdentifier | undefined; /** - *

- * The tags on the device identifier. - *

+ *

The tags on the device identifier.

*/ tags?: Record; } @@ -409,6 +514,30 @@ export interface ActivateNetworkSiteRequest { * idempotency.

*/ clientToken?: string; + + /** + *

Determines the duration and renewal status of the commitment period for all pending radio + * units.

+ *

If you include commitmentConfiguration in the + * ActivateNetworkSiteRequest action, you must specify the + * following:

+ *
    + *
  • + *

    The commitment period for the radio unit. You can choose a 60-day, 1-year, or + * 3-year period.

    + *
    • + *
  • + *

    Whether you want your commitment period to automatically renew for one more + * year after your current commitment period expires.

    + *
    • + *
+ *

For pricing, see Amazon Web Services Private 5G + * Pricing.

+ *

If you do not include commitmentConfiguration in the + * ActivateNetworkSiteRequest action, the commitment period is set to + * 60-days.

+ */ + commitmentConfiguration?: CommitmentConfiguration; } /** @@ -427,21 +556,6 @@ export interface NameValuePair { value?: string; } -/** - * @public - * @enum - */ -export const NetworkResourceDefinitionType = { - DEVICE_IDENTIFIER: "DEVICE_IDENTIFIER", - RADIO_UNIT: "RADIO_UNIT", -} as const; - -/** - * @public - */ -export type NetworkResourceDefinitionType = - (typeof NetworkResourceDefinitionType)[keyof typeof NetworkResourceDefinitionType]; - /** * @public *

Information about a network resource definition.

@@ -527,7 +641,8 @@ export interface NetworkSite { statusReason?: string; /** - *

The Amazon Resource Name (ARN) of the network to which the network site belongs.

+ *

The Amazon Resource Name (ARN) of the network to which the network site + * belongs.

*/ networkArn: string | undefined; @@ -547,16 +662,12 @@ export interface NetworkSite { createdAt?: Date; /** - *

- * The parent Availability Zone for the network site. - *

+ *

The parent Availability Zone for the network site.

*/ availabilityZone?: string; /** - *

- * The parent Availability Zone ID for the network site. - *

+ *

The parent Availability Zone ID for the network site.

*/ availabilityZoneId?: string; } @@ -571,6 +682,30 @@ export interface ActivateNetworkSiteResponse { networkSite?: NetworkSite; } +/** + * @public + *

Shows the duration, the date and time that the contract started and ends, and the + * renewal status of the commitment period for the radio unit.

+ */ +export interface CommitmentInformation { + /** + *

The duration and renewal status of the commitment period for the radio unit.

+ */ + commitmentConfiguration: CommitmentConfiguration | undefined; + + /** + *

The date and time that the commitment period started.

+ */ + startAt?: Date; + + /** + *

The date and time that the commitment period ends. If you do not cancel or renew the + * commitment before the expiration date, you will be billed at the 60-day-commitment + * rate.

+ */ + expiresOn?: Date; +} + /** * @public * @enum @@ -653,7 +788,8 @@ export interface ConfigureAccessPointRequest { cpiUsername?: string; /** - *

The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

+ *

The CPI user ID of the CPI user who is certifying the coordinates of the network + * resource.

*/ cpiUserId?: string; @@ -696,8 +832,8 @@ export interface ReturnInformation { shippingAddress?: Address; /** - *

The reason for the return. If the return request did not include a - * reason for the return, this value is null.

+ *

The reason for the return. If the return request did not include a reason for the + * return, this value is null.

*/ returnReason?: string; @@ -707,9 +843,10 @@ export interface ReturnInformation { replacementOrderArn?: string; /** - *

The URL of the shipping label. The shipping label is available for download - * only if the status of the network resource is PENDING_RETURN. - * For more information, see Return a radio unit.

+ *

The URL of the shipping label. The shipping label is available for download only if + * the status of the network resource is PENDING_RETURN. For more information, + * see Return a + * radio unit.

*/ shippingLabel?: string; } @@ -799,7 +936,8 @@ export interface NetworkResource { health?: HealthStatus | string; /** - *

The Amazon Resource Name (ARN) of the network on which this network resource appears.

+ *

The Amazon Resource Name (ARN) of the network on which this network resource + * appears.

*/ networkArn?: string; @@ -810,7 +948,8 @@ export interface NetworkResource { networkSiteArn?: string; /** - *

The Amazon Resource Name (ARN) of the order used to purchase this network resource.

+ *

The Amazon Resource Name (ARN) of the order used to purchase this network + * resource.

*/ orderArn?: string; @@ -833,6 +972,13 @@ export interface NetworkResource { *

Information about a request to return the network resource.

*/ returnInformation?: ReturnInformation; + + /** + *

Information about the commitment period for the radio unit. Shows the duration, the + * date and time that the contract started and ends, and the renewal status of the + * commitment period.

+ */ + commitmentInformation?: CommitmentInformation; } /** @@ -850,7 +996,8 @@ export interface ConfigureAccessPointResponse { */ export interface CreateNetworkRequest { /** - *

The name of the network. You can't change the name after you create the network.

+ *

The name of the network. You can't change the name after you create the + * network.

*/ networkName: string | undefined; @@ -867,9 +1014,7 @@ export interface CreateNetworkRequest { clientToken?: string; /** - *

- * The tags to apply to the network. - *

+ *

The tags to apply to the network.

*/ tags?: Record; } @@ -937,9 +1082,7 @@ export interface CreateNetworkResponse { network: Network | undefined; /** - *

- * The network tags. - *

+ *

The network tags.

*/ tags?: Record; } @@ -996,21 +1139,19 @@ export interface CreateNetworkSiteRequest { clientToken?: string; /** - *

The Availability Zone that is the parent of this site. You can't change the Availability Zone - * after you create the site.

+ *

The Availability Zone that is the parent of this site. You can't change the + * Availability Zone after you create the site.

*/ availabilityZone?: string; /** - *

The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone - * after you create the site.

+ *

The ID of the Availability Zone that is the parent of this site. You can't change the + * Availability Zone after you create the site.

*/ availabilityZoneId?: string; /** - *

- * The tags to apply to the network site. - *

+ *

The tags to apply to the network site.

*/ tags?: Record; } @@ -1025,9 +1166,7 @@ export interface CreateNetworkSiteResponse { networkSite?: NetworkSite; /** - *

- * The network site tags. - *

+ *

The network site tags.

*/ tags?: Record; } @@ -1148,9 +1287,7 @@ export interface GetDeviceIdentifierResponse { deviceIdentifier?: DeviceIdentifier; /** - *

- * The device identifier tags. - *

+ *

The device identifier tags.

*/ tags?: Record; } @@ -1175,9 +1312,7 @@ export interface GetNetworkResponse { network: Network | undefined; /** - *

- * The network tags. - *

+ *

The network tags.

*/ tags?: Record; } @@ -1202,9 +1337,7 @@ export interface GetNetworkResourceResponse { networkResource: NetworkResource | undefined; /** - *

- * The network resource tags. - *

+ *

The network resource tags.

*/ tags?: Record; } @@ -1229,9 +1362,7 @@ export interface GetNetworkSiteResponse { networkSite?: NetworkSite; /** - *

- * The network site tags. - *

+ *

The network site tags.

*/ tags?: Record; } @@ -1256,9 +1387,7 @@ export interface GetOrderResponse { order: Order | undefined; /** - *

- * The order tags. - *

+ *

The order tags.

*/ tags?: Record; } @@ -1276,11 +1405,13 @@ export interface ListDeviceIdentifiersRequest { * *
  • *

    - * STATUS - The status (ACTIVE | INACTIVE).

    + * STATUS - The status (ACTIVE | + * INACTIVE).

    *
    • *
  • *

    - * TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

    + * TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic + * group.

    *
    • * *

    Filter values are case sensitive. If you specify multiple @@ -1347,9 +1478,10 @@ export interface ListNetworkResourcesRequest { * *

  • *

    - * STATUS - The status (AVAILABLE | DELETED - * | DELETING | PENDING | PENDING_RETURN - * | PROVISIONING | SHIPPED).

    + * STATUS - The status (AVAILABLE | + * DELETED | DELETING | PENDING | + * PENDING_RETURN | PROVISIONING | + * SHIPPED).

    *
    • * *

    Filter values are case sensitive. If you specify multiple @@ -1411,8 +1543,9 @@ export interface ListNetworksRequest { *

      *
    • *

      - * STATUS - The status (AVAILABLE | CREATED - * | DELETED | DEPROVISIONING | PROVISIONING).

      + * STATUS - The status (AVAILABLE | + * CREATED | DELETED | DEPROVISIONING | + * PROVISIONING).

      *
      • *
    *

    Filter values are case sensitive. If you specify multiple @@ -1465,13 +1598,14 @@ export type NetworkSiteFilterKeys = (typeof NetworkSiteFilterKeys)[keyof typeof */ export interface ListNetworkSitesRequest { /** - *

    The filters. Add filters to your request to return a more - * specific list of results. Use filters to match the status of the network sites.

    + *

    The filters. Add filters to your request to return a more specific list of results. + * Use filters to match the status of the network sites.

    *
      *
    • *

      - * STATUS - The status (AVAILABLE | CREATED - * | DELETED | DEPROVISIONING | PROVISIONING).

      + * STATUS - The status (AVAILABLE | + * CREATED | DELETED | DEPROVISIONING | + * PROVISIONING).

      *
      • *
    *

    Filter values are case sensitive. If you specify multiple @@ -1549,12 +1683,13 @@ export interface ListOrdersRequest { *

      *
    • *

      - * NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.

      + * NETWORK_SITE - The Amazon Resource Name (ARN) of the network + * site.

      *
      • *
    • *

      - * STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED - * | UNACKNOWLEDGED).

      + * STATUS - The status (ACKNOWLEDGING | + * ACKNOWLEDGED | UNACKNOWLEDGED).

      *
      • *
    *

    Filter values are case sensitive. If you specify multiple @@ -1601,9 +1736,7 @@ export interface ListTagsForResourceResponse { /** * @public - *

    - * The request was denied due to request throttling. - *

    + *

    The request was denied due to request throttling.

    */ export class ThrottlingException extends __BaseException { readonly name: "ThrottlingException" = "ThrottlingException"; @@ -1639,6 +1772,7 @@ export interface PingResponse { * @enum */ export const UpdateType = { + COMMITMENT: "COMMITMENT", REPLACE: "REPLACE", RETURN: "RETURN", } as const; @@ -1662,15 +1796,22 @@ export interface StartNetworkResourceUpdateRequest { *
      *
    • *

      - * REPLACE - Submits a request to replace a defective - * radio unit. We provide a shipping label that you can use for the - * return process and we ship a replacement radio unit to you.

      + * REPLACE - Submits a request to replace a defective radio unit. We + * provide a shipping label that you can use for the return process and we ship a + * replacement radio unit to you.

      + *
      • + *
    • + *

      + * RETURN - Submits a request to return a radio unit that you no + * longer need. We provide a shipping label that you can use for the return + * process.

      *
      • *
    • *

      - * RETURN - Submits a request to replace a radio unit - * that you no longer need. We provide a shipping label that you can - * use for the return process.

      + * COMMITMENT - Submits a request to change or renew the commitment + * period. If you choose this value, then you must set + * commitmentConfiguration + * .

      *
      • *
    */ @@ -1678,8 +1819,8 @@ export interface StartNetworkResourceUpdateRequest { /** *

    The shipping address. If you don't provide a shipping address when replacing or - * returning a network resource, we use the address from the original order for the - * network resource.

    + * returning a network resource, we use the address from the original order for the network + * resource.

    */ shippingAddress?: Address; @@ -1687,6 +1828,40 @@ export interface StartNetworkResourceUpdateRequest { *

    The reason for the return. Providing a reason for a return is optional.

    */ returnReason?: string; + + /** + *

    Use this action to extend and automatically renew the commitment period for the radio + * unit. You can do the following:

    + *
      + *
    • + *

      Change a 60-day commitment to a 1-year or 3-year commitment. The change is + * immediate and the hourly rate decreases to the rate for the new commitment + * period.

      + *
      • + *
    • + *

      Change a 1-year commitment to a 3-year commitment. The change is immediate and + * the hourly rate decreases to the rate for the 3-year commitment period.

      + *
      • + *
    • + *

      Set a 1-year commitment to automatically renew for an additional 1 year. The + * hourly rate for the additional year will continue to be the same as your + * existing 1-year rate.

      + *
      • + *
    • + *

      Set a 3-year commitment to automatically renew for an additional 1 year. The + * hourly rate for the additional year will continue to be the same as your + * existing 3-year rate.

      + *
      • + *
    • + *

      Turn off a previously-enabled automatic renewal on a 1-year or 3-year + * commitment. You cannot use the automatic-renewal option for a 60-day + * commitment.

      + *
      • + *
    + *

    For pricing, see Amazon Web Services Private 5G + * Pricing.

    + */ + commitmentConfiguration?: CommitmentConfiguration; } /** @@ -1704,9 +1879,7 @@ export interface StartNetworkResourceUpdateResponse { */ export interface TagResourceRequest { /** - *

    - * The Amazon Resource Name (ARN) of the resource. - *

    + *

    The Amazon Resource Name (ARN) of the resource.

    */ resourceArn: string | undefined; @@ -1773,9 +1946,7 @@ export interface UpdateNetworkSiteResponse { networkSite?: NetworkSite; /** - *

    - * The network site tags. - *

    + *

    The network site tags.

    */ tags?: Record; } @@ -1817,6 +1988,7 @@ export const AddressFilterSensitiveLog = (obj: Address): any => ({ ...(obj.street1 && { street1: SENSITIVE_STRING }), ...(obj.street2 && { street2: SENSITIVE_STRING }), ...(obj.street3 && { street3: SENSITIVE_STRING }), + ...(obj.emailAddress && { emailAddress: SENSITIVE_STRING }), }); /** diff --git a/clients/client-privatenetworks/src/protocols/Aws_restJson1.ts b/clients/client-privatenetworks/src/protocols/Aws_restJson1.ts index bcbc61d259e67..40bbfc789c086 100644 --- a/clients/client-privatenetworks/src/protocols/Aws_restJson1.ts +++ b/clients/client-privatenetworks/src/protocols/Aws_restJson1.ts @@ -82,6 +82,8 @@ import { import { AccessDeniedException, Address, + CommitmentConfiguration, + CommitmentInformation, DeviceIdentifier, InternalServerException, LimitExceededException, @@ -176,6 +178,7 @@ export const se_ActivateNetworkSiteCommand = async ( body = JSON.stringify( take(input, { clientToken: [], + commitmentConfiguration: (_) => _json(_), networkSiteArn: [], shippingAddress: (_) => _json(_), }) @@ -751,6 +754,7 @@ export const se_StartNetworkResourceUpdateCommand = async ( let body: any; body = JSON.stringify( take(input, { + commitmentConfiguration: (_) => _json(_), networkResourceArn: [], returnReason: [], shippingAddress: (_) => _json(_), @@ -2413,6 +2417,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_Address omitted. +// se_CommitmentConfiguration omitted. + // se_DeviceIdentifierFilters omitted. // se_DeviceIdentifierFilterValues omitted. @@ -2460,6 +2466,19 @@ const se_Position = (input: Position, context: __SerdeContext): any => { // de_Address omitted. +// de_CommitmentConfiguration omitted. + +/** + * deserializeAws_restJson1CommitmentInformation + */ +const de_CommitmentInformation = (output: any, context: __SerdeContext): CommitmentInformation => { + return take(output, { + commitmentConfiguration: _json, + expiresOn: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + startAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), + }) as any; +}; + /** * deserializeAws_restJson1DeviceIdentifier */ @@ -2525,6 +2544,7 @@ const de_NetworkList = (output: any, context: __SerdeContext): Network[] => { const de_NetworkResource = (output: any, context: __SerdeContext): NetworkResource => { return take(output, { attributes: _json, + commitmentInformation: (_: any) => de_CommitmentInformation(_, context), createdAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), description: __expectString, health: __expectString, @@ -2602,11 +2622,16 @@ const de_Order = (output: any, context: __SerdeContext): Order => { networkArn: __expectString, networkSiteArn: __expectString, orderArn: __expectString, + orderedResources: _json, shippingAddress: _json, trackingInformation: _json, }) as any; }; +// de_OrderedResourceDefinition omitted. + +// de_OrderedResourceDefinitions omitted. + /** * deserializeAws_restJson1OrderList */ diff --git a/codegen/sdk-codegen/aws-models/privatenetworks.json b/codegen/sdk-codegen/aws-models/privatenetworks.json index 2af86ca344699..9b8e6427fa082 100644 --- a/codegen/sdk-codegen/aws-models/privatenetworks.json +++ b/codegen/sdk-codegen/aws-models/privatenetworks.json @@ -145,7 +145,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The tags on the device identifier. \n

    " + "smithy.api#documentation": "

    The tags on the device identifier.

    " } } } @@ -201,6 +201,12 @@ "traits": { "smithy.api#documentation": "

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

    " } + }, + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

    Determines the duration and renewal status of the commitment period for all pending radio\n units.

    \n

    If you include commitmentConfiguration in the\n ActivateNetworkSiteRequest action, you must specify the\n following:

    \n
      \n
    • \n

      The commitment period for the radio unit. You can choose a 60-day, 1-year, or\n 3-year period.

      \n
      • \n
    • \n

      Whether you want your commitment period to automatically renew for one more\n year after your current commitment period expires.

      \n
      • \n
    \n

    For pricing, see Amazon Web Services Private 5G\n Pricing.

    \n

    If you do not include commitmentConfiguration in the\n ActivateNetworkSiteRequest action, the commitment period is set to\n 60-days.

    " + } } } }, @@ -248,7 +254,7 @@ "phoneNumber": { "target": "com.amazonaws.privatenetworks#AddressContent", "traits": { - "smithy.api#documentation": "

    The phone number for this address.

    " + "smithy.api#documentation": "

    The recipient's phone number.

    " } }, "postalCode": { @@ -283,6 +289,12 @@ "traits": { "smithy.api#documentation": "

    The third line of the street address.

    " } + }, + "emailAddress": { + "target": "com.amazonaws.privatenetworks#AddressContent", + "traits": { + "smithy.api#documentation": "

    The recipient's email address.

    " + } } }, "traits": { @@ -314,6 +326,74 @@ } } }, + "com.amazonaws.privatenetworks#CommitmentConfiguration": { + "type": "structure", + "members": { + "commitmentLength": { + "target": "com.amazonaws.privatenetworks#CommitmentLength", + "traits": { + "smithy.api#documentation": "

    The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year\n period.

    ", + "smithy.api#required": {} + } + }, + "automaticRenewal": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

    Determines whether the commitment period for a radio unit is set to automatically\n renew for an additional 1 year after your current commitment period expires.

    \n

    Set to True, if you want your commitment period to automatically renew.\n Set to False if you do not want your commitment to automatically renew.

    \n

    You can do the following:

    \n
      \n
    • \n

      Set a 1-year commitment to automatically renew for an additional 1 year. The\n hourly rate for the additional year will continue to be the same as your\n existing 1-year rate.

      \n
      • \n
    • \n

      Set a 3-year commitment to automatically renew for an additional 1 year. The\n hourly rate for the additional year will continue to be the same as your\n existing 3-year rate.

      \n
      • \n
    • \n

      Turn off a previously-enabled automatic renewal on a 1-year or 3-year\n commitment.

      \n
      • \n
    \n

    You cannot use the automatic-renewal option for a 60-day\n commitment.

    ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

    Determines the duration and renewal status of the commitment period for a radio\n unit.

    \n

    For pricing, see Amazon Web Services Private 5G\n Pricing.

    " + } + }, + "com.amazonaws.privatenetworks#CommitmentInformation": { + "type": "structure", + "members": { + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

    The duration and renewal status of the commitment period for the radio unit.

    ", + "smithy.api#required": {} + } + }, + "startAt": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that the commitment period started.

    " + } + }, + "expiresOn": { + "target": "com.amazonaws.privatenetworks#Timestamp", + "traits": { + "smithy.api#documentation": "

    The date and time that the commitment period ends. If you do not cancel or renew the\n commitment before the expiration date, you will be billed at the 60-day-commitment\n rate.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Shows the duration, the date and time that the contract started and ends, and the\n renewal status of the commitment period for the radio unit.

    " + } + }, + "com.amazonaws.privatenetworks#CommitmentLength": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SIXTY_DAYS", + "value": "SIXTY_DAYS" + }, + { + "name": "ONE_YEAR", + "value": "ONE_YEAR" + }, + { + "name": "THREE_YEARS", + "value": "THREE_YEARS" + } + ] + } + }, "com.amazonaws.privatenetworks#ConfigureAccessPoint": { "type": "operation", "input": { @@ -334,7 +414,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Configures the specified network resource. \n

    \n

    \n Use this action to specify the geographic\n position of the hardware. You must provide Certified Professional Installer (CPI)\n credentials in the request so that we can obtain spectrum grants. For more information,\n see Radio\n units in the Amazon Web Services Private 5G User Guide.

    ", + "smithy.api#documentation": "

    Configures the specified network resource.

    \n

    Use this action to specify the geographic position of the hardware. You must provide\n Certified Professional Installer (CPI) credentials in the request so that we can obtain\n spectrum grants. For more information, see Radio units in the\n Amazon Web Services Private 5G User Guide.

    ", "smithy.api#http": { "uri": "/v1/network-resources/configure", "method": "POST", @@ -372,7 +452,7 @@ "cpiUserId": { "target": "com.amazonaws.privatenetworks#SensitiveString", "traits": { - "smithy.api#documentation": "

    The CPI user ID of the CPI user who is certifying the coordinates of the network resource.

    ", + "smithy.api#documentation": "

    The CPI user ID of the CPI user who is certifying the coordinates of the network\n resource.

    ", "smithy.api#length": { "min": 1, "max": 4096 @@ -448,7 +528,7 @@ "networkName": { "target": "com.amazonaws.privatenetworks#Name", "traits": { - "smithy.api#documentation": "

    The name of the network. You can't change the name after you create the network.

    ", + "smithy.api#documentation": "

    The name of the network. You can't change the name after you create the\n network.

    ", "smithy.api#required": {} } }, @@ -467,7 +547,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The tags to apply to the network.\n

    " + "smithy.api#documentation": "

    The tags to apply to the network.

    " } } } @@ -485,7 +565,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The network tags. \n

    " + "smithy.api#documentation": "

    The network tags.

    " } } } @@ -557,19 +637,19 @@ "availabilityZone": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    The Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

    " + "smithy.api#documentation": "

    The Availability Zone that is the parent of this site. You can't change the\n Availability Zone after you create the site.

    " } }, "availabilityZoneId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone \n after you create the site.

    " + "smithy.api#documentation": "

    The ID of the Availability Zone that is the parent of this site. You can't change the\n Availability Zone after you create the site.

    " } }, "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The tags to apply to the network site.\n

    " + "smithy.api#documentation": "

    The tags to apply to the network site.

    " } } } @@ -586,7 +666,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The network site tags.\n

    " + "smithy.api#documentation": "

    The network site tags.

    " } } } @@ -673,7 +753,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see \n DeleteNetworkSite in the \n API Reference for Amazon Web Services Private 5G.

    ", + "smithy.api#documentation": "

    Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private\n 5G.

    ", "smithy.api#http": { "uri": "/v1/networks/{networkArn}", "method": "DELETE", @@ -798,13 +878,13 @@ "trafficGroupArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the traffic group to which the device identifier\n belongs.

    " } }, "networkArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the network on which the device identifier appears.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the network on which the device identifier\n appears.

    " } }, "imsi": { @@ -835,7 +915,7 @@ "orderArn": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the order used to purchase the device\n identifier.

    " } }, "createdAt": { @@ -1371,8 +1451,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1384,8 +1464,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1397,8 +1477,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1410,8 +1490,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1423,8 +1503,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1436,8 +1516,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1449,8 +1529,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1462,8 +1542,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1475,8 +1555,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1488,8 +1568,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1501,8 +1581,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1514,8 +1594,19 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1527,8 +1618,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1540,8 +1642,19 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1553,8 +1666,19 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1566,8 +1690,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1579,8 +1703,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1592,8 +1716,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1604,8 +1728,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1616,10 +1740,16 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -1707,7 +1837,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The device identifier tags.\n

    " + "smithy.api#documentation": "

    The device identifier tags.

    " } } } @@ -1809,7 +1939,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The network resource tags.\n

    " + "smithy.api#documentation": "

    The network resource tags.

    " } } } @@ -1827,7 +1957,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The network tags.\n

    " + "smithy.api#documentation": "

    The network tags.

    " } } } @@ -1886,7 +2016,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The network site tags.\n

    " + "smithy.api#documentation": "

    The network site tags.

    " } } } @@ -1946,7 +2076,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The order tags.\n

    " + "smithy.api#documentation": "

    The order tags.

    " } } } @@ -2031,7 +2161,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists device identifiers. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, \n the status of device identifiers, or the ARN of the traffic group.

    \n

    If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

    ", + "smithy.api#documentation": "

    Lists device identifiers. Add filters to your request to return a more specific list\n of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status\n of device identifiers, or the ARN of the traffic group.

    \n

    If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

    ", "smithy.api#http": { "uri": "/v1/device-identifiers/list", "method": "POST", @@ -2052,7 +2182,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilters", "traits": { - "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n ORDER - The Amazon Resource Name (ARN) of the order.

      \n
      • \n
    • \n

      \n STATUS - The status (ACTIVE | INACTIVE).

      \n
      • \n
    • \n

      \n TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " + "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n ORDER - The Amazon Resource Name (ARN) of the order.

      \n
      • \n
    • \n

      \n STATUS - The status (ACTIVE |\n INACTIVE).

      \n
      • \n
    • \n

      \n TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic\n group.

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " } }, "networkArn": { @@ -2118,7 +2248,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists network resources. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or \n the status of network resources.

    \n

    If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

    ", + "smithy.api#documentation": "

    Lists network resources. Add filters to your request to return a more specific list of\n results. Use filters to match the Amazon Resource Name (ARN) of an order or the status\n of network resources.

    \n

    If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

    ", "smithy.api#http": { "uri": "/v1/network-resources", "method": "POST", @@ -2139,7 +2269,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#NetworkResourceFilters", "traits": { - "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n ORDER - The Amazon Resource Name (ARN) of the order.

      \n
      • \n
    • \n

      \n STATUS - The status (AVAILABLE | DELETED\n | DELETING | PENDING | PENDING_RETURN\n | PROVISIONING | SHIPPED).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " + "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n ORDER - The Amazon Resource Name (ARN) of the order.

      \n
      • \n
    • \n

      \n STATUS - The status (AVAILABLE |\n DELETED | DELETING | PENDING |\n PENDING_RETURN | PROVISIONING |\n SHIPPED).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " } }, "networkArn": { @@ -2205,7 +2335,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists network sites. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network site.

    ", + "smithy.api#documentation": "

    Lists network sites. Add filters to your request to return a more specific list of\n results. Use filters to match the status of the network site.

    ", "smithy.api#http": { "uri": "/v1/network-sites/list", "method": "POST", @@ -2226,7 +2356,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#NetworkSiteFilters", "traits": { - "smithy.api#documentation": "

    The filters. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network sites.

    \n
      \n
    • \n

      \n STATUS - The status (AVAILABLE | CREATED\n | DELETED | DEPROVISIONING | PROVISIONING).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " + "smithy.api#documentation": "

    The filters. Add filters to your request to return a more specific list of results.\n Use filters to match the status of the network sites.

    \n
      \n
    • \n

      \n STATUS - The status (AVAILABLE |\n CREATED | DELETED | DEPROVISIONING |\n PROVISIONING).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " } }, "networkArn": { @@ -2292,7 +2422,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists networks. Add filters to your request to return a more \n specific list of results. Use filters to match the status of the network.

    ", + "smithy.api#documentation": "

    Lists networks. Add filters to your request to return a more specific list of results.\n Use filters to match the status of the network.

    ", "smithy.api#http": { "uri": "/v1/networks/list", "method": "POST", @@ -2313,7 +2443,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#NetworkFilters", "traits": { - "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n STATUS - The status (AVAILABLE | CREATED\n | DELETED | DEPROVISIONING | PROVISIONING).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " + "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n STATUS - The status (AVAILABLE |\n CREATED | DELETED | DEPROVISIONING |\n PROVISIONING).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " } }, "startToken": { @@ -2372,7 +2502,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Lists orders. Add filters to your request to return a more \n specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or \n the status of the order.

    \n

    If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

    ", + "smithy.api#documentation": "

    Lists orders. Add filters to your request to return a more specific list of results.\n Use filters to match the Amazon Resource Name (ARN) of the network site or the status of\n the order.

    \n

    If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

    ", "smithy.api#http": { "uri": "/v1/orders/list", "method": "POST", @@ -2417,7 +2547,7 @@ "filters": { "target": "com.amazonaws.privatenetworks#OrderFilters", "traits": { - "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n NETWORK_SITE - The Amazon Resource Name (ARN) of the network site.

      \n
      • \n
    • \n

      \n STATUS - The status (ACKNOWLEDGING | ACKNOWLEDGED\n | UNACKNOWLEDGED).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " + "smithy.api#documentation": "

    The filters.

    \n
      \n
    • \n

      \n NETWORK_SITE - The Amazon Resource Name (ARN) of the network\n site.

      \n
      • \n
    • \n

      \n STATUS - The status (ACKNOWLEDGING |\n ACKNOWLEDGED | UNACKNOWLEDGED).

      \n
      • \n
    \n

    Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

    " } } } @@ -2674,7 +2804,7 @@ "networkArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the network on which this network resource appears.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the network on which this network resource\n appears.

    " } }, "networkSiteArn": { @@ -2686,7 +2816,7 @@ "orderArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the order used to purchase this network resource.

    " + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the order used to purchase this network\n resource.

    " } }, "attributes": { @@ -2712,6 +2842,12 @@ "traits": { "smithy.api#documentation": "

    Information about a request to return the network resource.

    " } + }, + "commitmentInformation": { + "target": "com.amazonaws.privatenetworks#CommitmentInformation", + "traits": { + "smithy.api#documentation": "

    Information about the commitment period for the radio unit. Shows the duration, the\n date and time that the contract started and ends, and the renewal status of the\n commitment period.

    " + } } }, "traits": { @@ -2899,7 +3035,7 @@ "networkArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the network to which the network site belongs.

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the network to which the network site\n belongs.

    ", "smithy.api#required": {} } }, @@ -2924,13 +3060,13 @@ "availabilityZone": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    \n The parent Availability Zone for the network site.\n

    " + "smithy.api#documentation": "

    The parent Availability Zone for the network site.

    " } }, "availabilityZoneId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    \n The parent Availability Zone ID for the network site.\n

    " + "smithy.api#documentation": "

    The parent Availability Zone ID for the network site.

    " } } }, @@ -3074,6 +3210,12 @@ "traits": { "smithy.api#documentation": "

    The creation time of the order.

    " } + }, + "orderedResources": { + "target": "com.amazonaws.privatenetworks#OrderedResourceDefinitions", + "traits": { + "smithy.api#documentation": "

    A list of the network resources placed in the order.

    " + } } }, "traits": { @@ -3116,6 +3258,43 @@ "target": "com.amazonaws.privatenetworks#Order" } }, + "com.amazonaws.privatenetworks#OrderedResourceDefinition": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitionType", + "traits": { + "smithy.api#documentation": "

    The type of network resource in the order.

    ", + "smithy.api#required": {} + } + }, + "count": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

    The number of network resources in the order.

    ", + "smithy.api#range": { + "min": 0 + }, + "smithy.api#required": {} + } + }, + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

    The duration and renewal status of the commitment period for each radio unit in the\n order. Does not show details if the resource type is DEVICE_IDENTIFIER.

    " + } + } + }, + "traits": { + "smithy.api#documentation": "

    Details of the network resources in the order.

    " + } + }, + "com.amazonaws.privatenetworks#OrderedResourceDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.privatenetworks#OrderedResourceDefinition" + } + }, "com.amazonaws.privatenetworks#PaginationToken": { "type": "string" }, @@ -3234,7 +3413,7 @@ "returnReason": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    The reason for the return. If the return request did not include a \n reason for the return, this value is null.

    " + "smithy.api#documentation": "

    The reason for the return. If the return request did not include a reason for the\n return, this value is null.

    " } }, "replacementOrderArn": { @@ -3246,7 +3425,7 @@ "shippingLabel": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

    The URL of the shipping label. The shipping label is available for download\n only if the status of the network resource is PENDING_RETURN.\n For more information, see Return a radio unit.

    " + "smithy.api#documentation": "

    The URL of the shipping label. The shipping label is available for download only if\n the status of the network resource is PENDING_RETURN. For more information,\n see Return a\n radio unit.

    " } } }, @@ -3300,7 +3479,7 @@ } ], "traits": { - "smithy.api#documentation": "

    Starts an update of the specified network resource.

    \n

    After you submit a request to replace or return a network resource, the status\n of the network resource is CREATING_SHIPPING_LABEL. The shipping label \n is available when the status of the network resource is PENDING_RETURN. \n After the network resource is successfully returned, its status is DELETED. \n For more information, see Return a radio unit.

    ", + "smithy.api#documentation": "

    Use this action to do the following tasks:

    \n
      \n
    • \n

      Update the duration and renewal status of the commitment period for a radio\n unit. The update goes into effect immediately.

      \n
      • \n
    • \n

      Request a replacement for a network resource.

      \n
      • \n
    • \n

      Request that you return a network resource.

      \n
      • \n
    \n

    After you submit a request to replace or return a network resource, the status of the\n network resource changes to CREATING_SHIPPING_LABEL. The shipping label is\n available when the status of the network resource is PENDING_RETURN. After\n the network resource is successfully returned, its status changes to\n DELETED. For more information, see Return a radio unit.

    ", "smithy.api#http": { "uri": "/v1/network-resources/update", "method": "POST", @@ -3322,14 +3501,14 @@ "updateType": { "target": "com.amazonaws.privatenetworks#UpdateType", "traits": { - "smithy.api#documentation": "

    The update type.

    \n
      \n
    • \n

      \n REPLACE - Submits a request to replace a defective\n radio unit. We provide a shipping label that you can use for the \n return process and we ship a replacement radio unit to you.

      \n
      • \n
    • \n

      \n RETURN - Submits a request to replace a radio unit\n that you no longer need. We provide a shipping label that you can \n use for the return process.

      \n
      • \n
    ", + "smithy.api#documentation": "

    The update type.

    \n
      \n
    • \n

      \n REPLACE - Submits a request to replace a defective radio unit. We\n provide a shipping label that you can use for the return process and we ship a\n replacement radio unit to you.

      \n
      • \n
    • \n

      \n RETURN - Submits a request to return a radio unit that you no\n longer need. We provide a shipping label that you can use for the return\n process.

      \n
      • \n
    • \n

      \n COMMITMENT - Submits a request to change or renew the commitment\n period. If you choose this value, then you must set \n commitmentConfiguration\n .

      \n
      • \n
    ", "smithy.api#required": {} } }, "shippingAddress": { "target": "com.amazonaws.privatenetworks#Address", "traits": { - "smithy.api#documentation": "

    The shipping address. If you don't provide a shipping address when replacing or\n returning a network resource, we use the address from the original order for the\n network resource.

    " + "smithy.api#documentation": "

    The shipping address. If you don't provide a shipping address when replacing or\n returning a network resource, we use the address from the original order for the network\n resource.

    " } }, "returnReason": { @@ -3341,6 +3520,12 @@ "max": 1000 } } + }, + "commitmentConfiguration": { + "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", + "traits": { + "smithy.api#documentation": "

    Use this action to extend and automatically renew the commitment period for the radio\n unit. You can do the following:

    \n
      \n
    • \n

      Change a 60-day commitment to a 1-year or 3-year commitment. The change is\n immediate and the hourly rate decreases to the rate for the new commitment\n period.

      \n
      • \n
    • \n

      Change a 1-year commitment to a 3-year commitment. The change is immediate and\n the hourly rate decreases to the rate for the 3-year commitment period.

      \n
      • \n
    • \n

      Set a 1-year commitment to automatically renew for an additional 1 year. The\n hourly rate for the additional year will continue to be the same as your\n existing 1-year rate.

      \n
      • \n
    • \n

      Set a 3-year commitment to automatically renew for an additional 1 year. The\n hourly rate for the additional year will continue to be the same as your\n existing 3-year rate.

      \n
      • \n
    • \n

      Turn off a previously-enabled automatic renewal on a 1-year or 3-year\n commitment. You cannot use the automatic-renewal option for a 60-day\n commitment.

      \n
      • \n
    \n

    For pricing, see Amazon Web Services Private 5G\n Pricing.

    " + } } } }, @@ -3420,7 +3605,7 @@ } ], "traits": { - "smithy.api#documentation": "

    \n Adds tags to the specified resource.\n

    ", + "smithy.api#documentation": "

    Adds tags to the specified resource.

    ", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -3434,7 +3619,7 @@ "resourceArn": { "target": "com.amazonaws.privatenetworks#Arn", "traits": { - "smithy.api#documentation": "

    \n The Amazon Resource Name (ARN) of the resource.\n

    ", + "smithy.api#documentation": "

    The Amazon Resource Name (ARN) of the resource.

    ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3470,7 +3655,7 @@ } }, "traits": { - "smithy.api#documentation": "

    \n The request was denied due to request throttling.\n

    ", + "smithy.api#documentation": "

    The request was denied due to request throttling.

    ", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { @@ -3682,7 +3867,7 @@ "tags": { "target": "com.amazonaws.privatenetworks#TagMap", "traits": { - "smithy.api#documentation": "

    \n The network site tags.\n

    " + "smithy.api#documentation": "

    The network site tags.

    " } } } @@ -3698,6 +3883,10 @@ { "value": "RETURN", "name": "RETURN" + }, + { + "value": "COMMITMENT", + "name": "COMMITMENT" } ] }