AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Private 5G StartNetworkResourceUpdate API operation.

Syntax

Start-PV5GNetworkResourceUpdate
-NetworkResourceArn <String>
-CommitmentConfiguration_AutomaticRenewal <Boolean>
-ShippingAddress_City <String>
-CommitmentConfiguration_CommitmentLength <CommitmentLength>
-ShippingAddress_Company <String>
-ShippingAddress_Country <String>
-ShippingAddress_EmailAddress <String>
-ShippingAddress_Name <String>
-ShippingAddress_PhoneNumber <String>
-ShippingAddress_PostalCode <String>
-ReturnReason <String>
-ShippingAddress_StateOrProvince <String>
-ShippingAddress_Street1 <String>
-ShippingAddress_Street2 <String>
-ShippingAddress_Street3 <String>
-UpdateType <UpdateType>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonPrivate5GConfig>

Description

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.

Parameters

-ClientConfig <AmazonPrivate5GConfig>
Amazon.PowerShell.Cmdlets.PV5G.AmazonPrivate5GClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CommitmentConfiguration_AutomaticRenewal <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CommitmentConfiguration_CommitmentLength <CommitmentLength>
The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkResourceArn <String>
The Amazon Resource Name (ARN) of the network resource.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the NetworkResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^NetworkResourceArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReturnReason <String>
The reason for the return. Providing a reason for a return is optional.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'NetworkResource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Private5G.Model.StartNetworkResourceUpdateResponse). Specifying the name of a property of type Amazon.Private5G.Model.StartNetworkResourceUpdateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_City <String>
The city for this address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_Company <String>
The company name for this address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_Country <String>
The country for this address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_EmailAddress <String>
The recipient's email address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_Name <String>
The recipient's name for this address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_PhoneNumber <String>
The recipient's phone number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_PostalCode <String>
The postal code for this address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_StateOrProvince <String>
The state or province for this address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_Street1 <String>
The first line of the street address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_Street2 <String>
The second line of the street address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingAddress_Street3 <String>
The third line of the street address.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-UpdateType <UpdateType>
The update type.
  • 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.
  • COMMITMENT - Submits a request to change or renew the commitment period. If you choose this value, then you must set commitmentConfiguration.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Private5G.Model.NetworkResource or Amazon.Private5G.Model.StartNetworkResourceUpdateResponse
This cmdlet returns an Amazon.Private5G.Model.NetworkResource object. The service call response (type Amazon.Private5G.Model.StartNetworkResourceUpdateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z