Private5G / Client / start_network_resource_update

start_network_resource_update#

Private5G.Client.start_network_resource_update(**kwargs)#

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.

Request Syntax

response = client.start_network_resource_update(
    commitmentConfiguration={
        'automaticRenewal': True|False,
        'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
    },
    networkResourceArn='string',
    returnReason='string',
    shippingAddress={
        'city': 'string',
        'company': 'string',
        'country': 'string',
        'emailAddress': 'string',
        'name': 'string',
        'phoneNumber': 'string',
        'postalCode': 'string',
        'stateOrProvince': 'string',
        'street1': 'string',
        'street2': 'string',
        'street3': 'string'
    },
    updateType='REPLACE'|'RETURN'|'COMMITMENT'
)

Parameters:

commitmentConfiguration (dict) –
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.
- automaticRenewal (boolean) – [REQUIRED]
  
  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.
- commitmentLength (string) – [REQUIRED]
  
  The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
networkResourceArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the network resource.
returnReason (string) – The reason for the return. Providing a reason for a return is optional.
shippingAddress (dict) –
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.
- city (string) – [REQUIRED]
  
  The city for this address.
- company (string) –
  
  The company name for this address.
- country (string) – [REQUIRED]
  
  The country for this address.
- emailAddress (string) –
  
  The recipient’s email address.
- name (string) – [REQUIRED]
  
  The recipient’s name for this address.
- phoneNumber (string) –
  
  The recipient’s phone number.
- postalCode (string) – [REQUIRED]
  
  The postal code for this address.
- stateOrProvince (string) – [REQUIRED]
  
  The state or province for this address.
- street1 (string) – [REQUIRED]
  
  The first line of the street address.
- street2 (string) –
  
  The second line of the street address.
- street3 (string) –
  
  The third line of the street address.
updateType (string) –
[REQUIRED]

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.

Return type:

dict

Returns:

Response Syntax

{
    'networkResource': {
        'attributes': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        'commitmentInformation': {
            'commitmentConfiguration': {
                'automaticRenewal': True|False,
                'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
            },
            'expiresOn': datetime(2015, 1, 1),
            'startAt': datetime(2015, 1, 1)
        },
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'health': 'INITIAL'|'HEALTHY'|'UNHEALTHY',
        'model': 'string',
        'networkArn': 'string',
        'networkResourceArn': 'string',
        'networkSiteArn': 'string',
        'orderArn': 'string',
        'position': {
            'elevation': 123.0,
            'elevationReference': 'AGL'|'AMSL',
            'elevationUnit': 'FEET',
            'latitude': 123.0,
            'longitude': 123.0
        },
        'returnInformation': {
            'replacementOrderArn': 'string',
            'returnReason': 'string',
            'shippingAddress': {
                'city': 'string',
                'company': 'string',
                'country': 'string',
                'emailAddress': 'string',
                'name': 'string',
                'phoneNumber': 'string',
                'postalCode': 'string',
                'stateOrProvince': 'string',
                'street1': 'string',
                'street2': 'string',
                'street3': 'string'
            },
            'shippingLabel': 'string'
        },
        'serialNumber': 'string',
        'status': 'PENDING'|'SHIPPED'|'PROVISIONING'|'PROVISIONED'|'AVAILABLE'|'DELETING'|'PENDING_RETURN'|'DELETED'|'CREATING_SHIPPING_LABEL',
        'statusReason': 'string',
        'type': 'RADIO_UNIT',
        'vendor': 'string'
    }
}

Response Structure

(dict) –
- networkResource (dict) –
  
  The network resource.
  - attributes (list) –
    
    The attributes of the network resource.
    - (dict) –
      
      Information about a name/value pair.
      - name (string) –
        
        The name of the pair.
      - value (string) –
        
        The value of the pair.
  - commitmentInformation (dict) –
    
    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.
    - commitmentConfiguration (dict) –
      
      The duration and renewal status of the commitment period for the radio unit.
      - 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.
      - commitmentLength (string) –
        
        The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year period.
    - expiresOn (datetime) –
      
      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.
    - startAt (datetime) –
      
      The date and time that the commitment period started.
  - createdAt (datetime) –
    
    The creation time of the network resource.
  - description (string) –
    
    The description of the network resource.
  - health (string) –
    
    The health of the network resource.
  - model (string) –
    
    The model of the network resource.
  - networkArn (string) –
    
    The Amazon Resource Name (ARN) of the network on which this network resource appears.
  - networkResourceArn (string) –
    
    The Amazon Resource Name (ARN) of the network resource.
  - networkSiteArn (string) –
    
    The Amazon Resource Name (ARN) of the network site on which this network resource appears.
  - orderArn (string) –
    
    The Amazon Resource Name (ARN) of the order used to purchase this network resource.
  - position (dict) –
    
    The position of the network resource.
    - elevation (float) –
      
      The elevation of the equipment at this position.
    - elevationReference (string) –
      
      The reference point from which elevation is reported.
    - elevationUnit (string) –
      
      The units used to measure the elevation of the position.
    - latitude (float) –
      
      The latitude of the position.
    - longitude (float) –
      
      The longitude of the position.
  - returnInformation (dict) –
    
    Information about a request to return the network resource.
    - replacementOrderArn (string) –
      
      The Amazon Resource Name (ARN) of the replacement order.
    - returnReason (string) –
      
      The reason for the return. If the return request did not include a reason for the return, this value is null.
    - shippingAddress (dict) –
      
      The shipping address.
      - city (string) –
        
        The city for this address.
      - company (string) –
        
        The company name for this address.
      - country (string) –
        
        The country for this address.
      - emailAddress (string) –
        
        The recipient’s email address.
      - name (string) –
        
        The recipient’s name for this address.
      - phoneNumber (string) –
        
        The recipient’s phone number.
      - postalCode (string) –
        
        The postal code for this address.
      - stateOrProvince (string) –
        
        The state or province for this address.
      - street1 (string) –
        
        The first line of the street address.
      - street2 (string) –
        
        The second line of the street address.
      - street3 (string) –
        
        The third line of the street address.
    - shippingLabel (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.
  - serialNumber (string) –
    
    The serial number of the network resource.
  - status (string) –
    
    The status of the network resource.
  - statusReason (string) –
    
    The status reason of the network resource.
  - type (string) –
    
    The type of the network resource.
  - vendor (string) –
    
    The vendor of the network resource.

Exceptions

Private5G.Client.exceptions.ResourceNotFoundException
Private5G.Client.exceptions.ValidationException
Private5G.Client.exceptions.InternalServerException