openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 106 kB
JSON
{"openapi":"3.0.0","info":{"version":"2021-12-03","x-release":"v4","title":"AWS Private 5G","description":"Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale your own private mobile network at your on-premises location. Private 5G provides the pre-configured hardware and software for mobile networks, helps automate setup, and scales capacity on demand to support additional devices as needed.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"privatenetworks","x-aws-signingName":"private-networks","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/privatenetworks-2021-12-03.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/private-networks/"},"servers":[{"url":"http://private-networks.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Private 5G multi-region endpoint"},{"url":"https://private-networks.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Private 5G multi-region endpoint"},{"url":"http://private-networks.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Private 5G endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://private-networks.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Private 5G endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/v1/orders/acknowledge":{"post":{"operationId":"AcknowledgeOrderReceipt","description":"Acknowledges that the specified network order was received.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeOrderReceiptResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderArn"],"properties":{"orderArn":{"description":"The Amazon Resource Name (ARN) of the order.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/device-identifiers/activate":{"post":{"operationId":"ActivateDeviceIdentifier","description":"Activates the specified device identifier.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateDeviceIdentifierResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceIdentifierArn"],"properties":{"clientToken":{"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","type":"string","minLength":1,"maxLength":100},"deviceIdentifierArn":{"description":"The Amazon Resource Name (ARN) of the device identifier.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-sites/activate":{"post":{"operationId":"ActivateNetworkSite","description":"Activates the specified network site.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivateNetworkSiteResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkSiteArn","shippingAddress"],"properties":{"clientToken":{"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","type":"string","minLength":1,"maxLength":100},"commitmentConfiguration":{"description":"<p>Determines the duration and renewal status of the commitment period for a radio unit.</p> <p>For pricing, see <a href=\"http://aws.amazon.com/private5g/pricing\">Amazon Web Services Private 5G Pricing</a>.</p>","type":"object","properties":{"automaticRenewal":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"<p>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.</p> <p>Set to <code>True</code>, if you want your commitment period to automatically renew. Set to <code>False</code> if you do not want your commitment to automatically renew.</p> <p>You can do the following:</p> <ul> <li> <p>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.</p> </li> <li> <p>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.</p> </li> <li> <p>Turn off a previously-enabled automatic renewal on a 1-year or 3-year commitment.</p> </li> </ul> <p>You cannot use the automatic-renewal option for a 60-day commitment.</p>"}]},"commitmentLength":{"allOf":[{"$ref":"#/components/schemas/CommitmentLength"},{"description":"The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period."}]}}},"networkSiteArn":{"description":"The Amazon Resource Name (ARN) of the network site.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"shippingAddress":{"description":"Information about an address.","type":"object","properties":{"city":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The city for this address."}]},"company":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The company name for this address."}]},"country":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The country for this address."}]},"emailAddress":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The recipient's email address."}]},"name":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The recipient's name for this address."}]},"phoneNumber":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The recipient's phone number."}]},"postalCode":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The postal code for this address."}]},"stateOrProvince":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The state or province for this address."}]},"street1":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The first line of the street address."}]},"street2":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The second line of the street address."}]},"street3":{"allOf":[{"$ref":"#/components/schemas/AddressContent"},{"description":"The third line of the street address."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-resources/configure":{"post":{"operationId":"ConfigureAccessPoint","description":"<p>Configures the specified network resource. </p> <p> Use this action to specify the geographic position of the hardware. You must provide Certified Professional Installer (CPI) credentials in the request so that we can obtain spectrum grants. For more information, see <a href=\"https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html\">Radio units</a> in the <i>Amazon Web Services Private 5G User Guide</i>. </p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigureAccessPointResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessPointArn"],"properties":{"accessPointArn":{"description":"The Amazon Resource Name (ARN) of the network resource.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"cpiSecretKey":{"description":"A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource. ","type":"string","minLength":1,"maxLength":100000,"format":"password"},"cpiUserId":{"description":"The CPI user ID of the CPI user who is certifying the coordinates of the network resource. ","type":"string","minLength":1,"maxLength":4096,"format":"password"},"cpiUserPassword":{"description":"The CPI password associated with the CPI certificate in <code>cpiSecretKey</code>.","type":"string","minLength":1,"maxLength":4096,"format":"password"},"cpiUsername":{"description":"The CPI user name of the CPI user who is certifying the coordinates of the radio unit.","type":"string","minLength":1,"maxLength":4096,"format":"password"},"position":{"description":"Information about a position.","type":"object","properties":{"elevation":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The elevation of the equipment at this position."}]},"elevationReference":{"allOf":[{"$ref":"#/components/schemas/ElevationReference"},{"description":"The reference point from which elevation is reported."}]},"elevationUnit":{"allOf":[{"$ref":"#/components/schemas/ElevationUnit"},{"description":"The units used to measure the elevation of the position."}]},"latitude":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The latitude of the position."}]},"longitude":{"allOf":[{"$ref":"#/components/schemas/Double"},{"description":"The longitude of the position."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/networks":{"post":{"operationId":"CreateNetwork","description":"Creates a network.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNetworkResponse"}}}},"480":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkName"],"properties":{"clientToken":{"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","type":"string","minLength":1,"maxLength":100},"description":{"description":"The description of the network.","type":"string","minLength":0,"maxLength":100},"networkName":{"description":"The name of the network. You can't change the name after you create the network.","type":"string","pattern":"^[0-9a-zA-Z-]*$","minLength":1,"maxLength":64},"tags":{"description":" The tags to apply to the network. ","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-sites":{"post":{"operationId":"CreateNetworkSite","description":"Creates a network site.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNetworkSiteResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkArn","networkSiteName"],"properties":{"availabilityZone":{"description":"The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.","type":"string"},"availabilityZoneId":{"description":"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.","type":"string"},"clientToken":{"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","type":"string","minLength":1,"maxLength":100},"description":{"description":"The description of the site.","type":"string","minLength":0,"maxLength":100},"networkArn":{"description":"The Amazon Resource Name (ARN) of the network.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"networkSiteName":{"description":"The name of the site. You can't change the name after you create the site.","type":"string","pattern":"^[0-9a-zA-Z-]*$","minLength":1,"maxLength":64},"pendingPlan":{"description":"Information about a site plan.","type":"object","properties":{"options":{"allOf":[{"$ref":"#/components/schemas/Options"},{"description":"The options of the plan."}]},"resourceDefinitions":{"allOf":[{"$ref":"#/components/schemas/NetworkResourceDefinitions"},{"description":"The resource definitions of the plan."}]}}},"tags":{"description":" The tags to apply to the network site. ","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/device-identifiers/deactivate":{"post":{"operationId":"DeactivateDeviceIdentifier","description":"Deactivates the specified device identifier.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeactivateDeviceIdentifierResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["deviceIdentifierArn"],"properties":{"clientToken":{"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","type":"string","minLength":1,"maxLength":100},"deviceIdentifierArn":{"description":"The Amazon Resource Name (ARN) of the device identifier.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/networks/{networkArn}":{"delete":{"operationId":"DeleteNetwork","description":"Deletes the specified network. You must delete network sites before you delete the network. For more information, see <a href=\"https://docs.aws.amazon.com/private-networks/latest/APIReference/API_DeleteNetworkSite.html\">DeleteNetworkSite</a> in the <i>API Reference for Amazon Web Services Private 5G</i>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNetworkResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"clientToken","in":"query","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"networkArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the network.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetNetwork","description":"Gets the specified network.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNetworkResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"networkArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the network.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]}},"/v1/network-sites/{networkSiteArn}":{"delete":{"operationId":"DeleteNetworkSite","description":"Deletes the specified network site. Return the hardware after you delete the network site. You are responsible for minimum charges. For more information, see <a href=\"https://docs.aws.amazon.com/private-networks/latest/userguide/hardware-maintenance.html\">Hardware returns</a> in the <i>Amazon Web Services Private 5G User Guide</i>. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNetworkSiteResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"clientToken","in":"query","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to ensure idempotency</a>.","schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"networkSiteArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the network site.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetNetworkSite","description":"Gets the specified network site.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNetworkSiteResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"networkSiteArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the network site.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]}},"/v1/device-identifiers/{deviceIdentifierArn}":{"get":{"operationId":"GetDeviceIdentifier","description":"Gets the specified device identifier.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDeviceIdentifierResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"deviceIdentifierArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the device identifier.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-resources/{networkResourceArn}":{"get":{"operationId":"GetNetworkResource","description":"Gets the specified network resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNetworkResourceResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"networkResourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the network resource.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/orders/{orderArn}":{"get":{"operationId":"GetOrder","description":"Gets the specified order.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrderResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"orderArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the order.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/device-identifiers/list":{"post":{"operationId":"ListDeviceIdentifiers","description":"<p>Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.</p> <p>If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeviceIdentifiersResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"startToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkArn"],"properties":{"filters":{"description":"<p>The filters.</p> <ul> <li> <p> <code>ORDER</code> - The Amazon Resource Name (ARN) of the order.</p> </li> <li> <p> <code>STATUS</code> - The status (<code>ACTIVE</code> | <code>INACTIVE</code>).</p> </li> <li> <p> <code>TRAFFIC_GROUP</code> - The Amazon Resource Name (ARN) of the traffic group.</p> </li> </ul> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceIdentifierFilterValues"}},"maxResults":{"description":"The maximum number of results to return.","type":"integer","minimum":1,"maximum":20},"networkArn":{"description":"The Amazon Resource Name (ARN) of the network.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"startToken":{"description":"The token for the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-resources":{"post":{"operationId":"ListNetworkResources","description":"<p>Lists network resources. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order or the status of network resources.</p> <p>If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNetworkResourcesResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"startToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkArn"],"properties":{"filters":{"description":"<p>The filters.</p> <ul> <li> <p> <code>ORDER</code> - The Amazon Resource Name (ARN) of the order.</p> </li> <li> <p> <code>STATUS</code> - The status (<code>AVAILABLE</code> | <code>DELETED</code> | <code>DELETING</code> | <code>PENDING</code> | <code>PENDING_RETURN</code> | <code>PROVISIONING</code> | <code>SHIPPED</code>).</p> </li> </ul> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/NetworkResourceFilterValues"}},"maxResults":{"description":"The maximum number of results to return.","type":"integer","minimum":1,"maximum":20},"networkArn":{"description":"The Amazon Resource Name (ARN) of the network.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"startToken":{"description":"The token for the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-sites/list":{"post":{"operationId":"ListNetworkSites","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNetworkSitesResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"startToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkArn"],"properties":{"filters":{"description":"<p>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.</p> <ul> <li> <p> <code>STATUS</code> - The status (<code>AVAILABLE</code> | <code>CREATED</code> | <code>DELETED</code> | <code>DEPROVISIONING</code> | <code>PROVISIONING</code>).</p> </li> </ul> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/NetworkSiteFilterValues"}},"maxResults":{"description":"The maximum number of results to return.","type":"integer","minimum":1,"maximum":20},"networkArn":{"description":"The Amazon Resource Name (ARN) of the network.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"startToken":{"description":"The token for the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/networks/list":{"post":{"operationId":"ListNetworks","description":"Lists networks. Add filters to your request to return a more specific list of results. Use filters to match the status of the network.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNetworksResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"startToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filters":{"description":"<p>The filters.</p> <ul> <li> <p> <code>STATUS</code> - The status (<code>AVAILABLE</code> | <code>CREATED</code> | <code>DELETED</code> | <code>DEPROVISIONING</code> | <code>PROVISIONING</code>).</p> </li> </ul> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/NetworkFilterValues"}},"maxResults":{"description":"The maximum number of results to return.","type":"integer","minimum":1,"maximum":20},"startToken":{"description":"The token for the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/orders/list":{"post":{"operationId":"ListOrders","description":"<p>Lists orders. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of the network site or the status of the order.</p> <p>If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrdersResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"startToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkArn"],"properties":{"filters":{"description":"<p>The filters.</p> <ul> <li> <p> <code>NETWORK_SITE</code> - The Amazon Resource Name (ARN) of the network site.</p> </li> <li> <p> <code>STATUS</code> - The status (<code>ACKNOWLEDGING</code> | <code>ACKNOWLEDGED</code> | <code>UNACKNOWLEDGED</code>).</p> </li> </ul> <p>Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.</p>","type":"object","additionalProperties":{"$ref":"#/components/schemas/OrderFilterValues"}},"maxResults":{"description":"The maximum number of results to return.","type":"integer","minimum":1,"maximum":20},"networkArn":{"description":"The Amazon Resource Name (ARN) of the network.","type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"},"startToken":{"description":"The token for the next page of results.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}":{"get":{"operationId":"ListTagsForResource","description":"Lists the tags for the specified resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The Amazon Resource Name (ARN) of the resource.","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":" Adds tags to the specified resource. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":" The Amazon Resource Name (ARN) of the resource. ","schema":{"type":"string","pattern":"^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"description":"The tags to add to the resource.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/ping":{"get":{"operationId":"Ping","description":"Checks the health of the service.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/v1/network-resources/update":{"post":{"operationId":"StartNetworkResourceUpdate","description":"<p>Use this action to do the following tasks:</p> <ul> <li> <p>Update the duration and renewal status of the commitment period for a radio unit. The update goes into effect immediately.</p> </li> <li> <p>Request a replacement for a network resource.</p> </li> <li> <p>Request that you return a network resource.</p> </li> </ul> <p>After you submit a request to replace or return a network resource, the status of the network resource changes to <code>CREATING_SHIPPING_LABEL</code>. The shipping label is available when the status of the network resource is <code>PENDING_RETURN</code>. After the network resource is successfully returned, its status changes to <code>DELETED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit\">Return a radio unit</a>.</p>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartNetworkResourceUpdateResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["networkResourceArn","updateType"],"properties":{"commitmentConfiguration":{"description":"<p>Determines the duration and renewal status of the commitment period for a radio unit.</p> <p>For pricing, see <a href=\"http://aws.amazon.com/private5g/pricing\">Amazon Web Services Private 5G Pricing</a>.</p>","type":"object","properties":{"automaticRenewal":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"<p>Determines wheth