Private5G / Client / activate_network_site

activate_network_site#

Private5G.Client.activate_network_site(**kwargs)#

Activates the specified network site.

Request Syntax

response = client.activate_network_site(
    clientToken='string',
    commitmentConfiguration={
        'automaticRenewal': True|False,
        'commitmentLength': 'SIXTY_DAYS'|'ONE_YEAR'|'THREE_YEARS'
    },
    networkSiteArn='string',
    shippingAddress={
        'city': 'string',
        'company': 'string',
        'country': 'string',
        'emailAddress': 'string',
        'name': 'string',
        'phoneNumber': 'string',
        'postalCode': 'string',
        'stateOrProvince': 'string',
        'street1': 'string',
        'street2': 'string',
        'street3': 'string'
    }
)

Parameters:

clientToken (string) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
commitmentConfiguration (dict) –
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.
- 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.
networkSiteArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the network site.
shippingAddress (dict) –
[REQUIRED]

The shipping address of the network site.
- 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.

Return type:

dict

Returns:

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    }
}

Response Structure

(dict) –
- networkSite (dict) –
  
  Information about the network site.
  - availabilityZone (string) –
    
    The parent Availability Zone for the network site.
  - availabilityZoneId (string) –
    
    The parent Availability Zone ID for the network site.
  - createdAt (datetime) –
    
    The creation time of the network site.
  - currentPlan (dict) –
    
    The current plan of the network site.
    - options (list) –
      
      The options of the plan.
      - (dict) –
        
        Information about a name/value pair.
        
        name (string) –
        
        The name of the pair.
        
        value (string) –
        
        The value of the pair.
    - resourceDefinitions (list) –
      
      The resource definitions of the plan.
      - (dict) –
        
        Information about a network resource definition.
        
        count (integer) –
        
        The count in the network resource definition.
        
        options (list) –
        
        The options in the network resource definition.
        
        (dict) –
        
        Information about a name/value pair.
        
        name (string) –
        
        The name of the pair.
        
        value (string) –
        
        The value of the pair.
        
        type (string) –
        
        The type in the network resource definition.
  - description (string) –
    
    The description of the network site.
  - networkArn (string) –
    
    The Amazon Resource Name (ARN) of the network to which the network site belongs.
  - networkSiteArn (string) –
    
    The Amazon Resource Name (ARN) of the network site.
  - networkSiteName (string) –
    
    The name of the network site.
  - pendingPlan (dict) –
    
    The pending plan of the network site.
    - options (list) –
      
      The options of the plan.
      - (dict) –
        
        Information about a name/value pair.
        
        name (string) –
        
        The name of the pair.
        
        value (string) –
        
        The value of the pair.
    - resourceDefinitions (list) –
      
      The resource definitions of the plan.
      - (dict) –
        
        Information about a network resource definition.
        
        count (integer) –
        
        The count in the network resource definition.
        
        options (list) –
        
        The options in the network resource definition.
        
        (dict) –
        
        Information about a name/value pair.
        
        name (string) –
        
        The name of the pair.
        
        value (string) –
        
        The value of the pair.
        
        type (string) –
        
        The type in the network resource definition.
  - status (string) –
    
    The status of the network site.
  - statusReason (string) –
    
    The status reason of the network site.

Exceptions

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