AWS API Changes

2023/02/15 - AWS Private 5G - 1 new 3 updated api methods

Changes This release introduces a new StartNetworkResourceUpdate API, which enables return/replacement of hardware from a NetworkSite.

StartNetworkResourceUpdate (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.start_network_resource_update(
    networkResourceArn='string',
    returnReason='string',
    shippingAddress={
        'city': 'string',
        'company': 'string',
        'country': 'string',
        'name': 'string',
        'phoneNumber': 'string',
        'postalCode': 'string',
        'stateOrProvince': 'string',
        'street1': 'string',
        'street2': 'string',
        'street3': 'string'
    },
    updateType='REPLACE'|'RETURN'
)

type networkResourceArn

string

param networkResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the network resource.

type returnReason

string

param returnReason

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

type shippingAddress

dict

param shippingAddress

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.
name (string) -- [REQUIRED]

The recipient's name for this address.
phoneNumber (string) --

The phone number for this address.
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.

type updateType

string

param updateType

[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 replace a radio unit that you no longer need. We provide a shipping label that you can use for the return process.

rtype

dict

returns

Response Syntax

{
    'networkResource': {
        'attributes': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        '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',
                '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.
  - 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.
      - name (string) --
        
        The recipient's name for this address.
      - phoneNumber (string) --
        
        The phone number for this address.
      - 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.

ConfigureAccessPoint (updated)

Link ¶
Changes (response)

{'accessPoint': {'returnInformation': {'replacementOrderArn': 'string',
                                       'returnReason': 'string',
                                       'shippingAddress': {'city': 'string',
                                                           'company': 'string',
                                                           'country': 'string',
                                                           'name': 'string',
                                                           'phoneNumber': 'string',
                                                           'postalCode': 'string',
                                                           'stateOrProvince': 'string',
                                                           'street1': 'string',
                                                           'street2': 'string',
                                                           'street3': 'string'},
                                       'shippingLabel': 'string'},
                 'status': {'CREATING_SHIPPING_LABEL'}}}

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 .

See also: AWS API Documentation

Request Syntax

client.configure_access_point(
    accessPointArn='string',
    cpiSecretKey='string',
    cpiUserId='string',
    cpiUserPassword='string',
    cpiUsername='string',
    position={
        'elevation': 123.0,
        'elevationReference': 'AGL'|'AMSL',
        'elevationUnit': 'FEET',
        'latitude': 123.0,
        'longitude': 123.0
    }
)

type accessPointArn

string

param accessPointArn

[REQUIRED]

The Amazon Resource Name (ARN) of the network resource.

type cpiSecretKey

string

param cpiSecretKey

A Base64 encoded string of the CPI certificate associated with the CPI user who is certifying the coordinates of the network resource.

type cpiUserId

string

param cpiUserId

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

type cpiUserPassword

string

param cpiUserPassword

The CPI password associated with the CPI certificate in cpiSecretKey .

type cpiUsername

string

param cpiUsername

The CPI user name of the CPI user who is certifying the coordinates of the radio unit.

type position

dict

param position

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.

rtype

dict

returns

Response Syntax

{
    'accessPoint': {
        'attributes': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        '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',
                '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) --
- accessPoint (dict) --
  
  Information about 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.
  - 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.
      - name (string) --
        
        The recipient's name for this address.
      - phoneNumber (string) --
        
        The phone number for this address.
      - 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.

GetNetworkResource (updated)

Link ¶
Changes (response)

{'networkResource': {'returnInformation': {'replacementOrderArn': 'string',
                                           'returnReason': 'string',
                                           'shippingAddress': {'city': 'string',
                                                               'company': 'string',
                                                               'country': 'string',
                                                               'name': 'string',
                                                               'phoneNumber': 'string',
                                                               'postalCode': 'string',
                                                               'stateOrProvince': 'string',
                                                               'street1': 'string',
                                                               'street2': 'string',
                                                               'street3': 'string'},
                                           'shippingLabel': 'string'},
                     'status': {'CREATING_SHIPPING_LABEL'}}}

Gets the specified network resource.

See also: AWS API Documentation

Request Syntax

client.get_network_resource(
    networkResourceArn='string'
)

type networkResourceArn

string

param networkResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the network resource.

rtype

dict

returns

Response Syntax

{
    'networkResource': {
        'attributes': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        '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',
                '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'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- networkResource (dict) --
  
  Information about 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.
  - 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.
      - name (string) --
        
        The recipient's name for this address.
      - phoneNumber (string) --
        
        The phone number for this address.
      - 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.
- tags (dict) --
  
  The network resource tags.
  - (string) --
    - (string) --

ListNetworkResources (updated)

Link ¶
Changes (response)

{'networkResources': {'returnInformation': {'replacementOrderArn': 'string',
                                            'returnReason': 'string',
                                            'shippingAddress': {'city': 'string',
                                                                'company': 'string',
                                                                'country': 'string',
                                                                'name': 'string',
                                                                'phoneNumber': 'string',
                                                                'postalCode': 'string',
                                                                'stateOrProvince': 'string',
                                                                'street1': 'string',
                                                                'street2': 'string',
                                                                'street3': 'string'},
                                            'shippingLabel': 'string'},
                      'status': {'CREATING_SHIPPING_LABEL'}}}

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.

See also: AWS API Documentation

Request Syntax

client.list_network_resources(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    networkArn='string',
    startToken='string'
)

type filters

dict

param filters

The filters.

ORDER - The Amazon Resource Name (ARN) of the order.
STATUS - The status ( AVAILABLE | DELETED | DELETING | PENDING | PENDING_RETURN | PROVISIONING | SHIPPED ).

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

(string) --
- (list) --
  - (string) --

type maxResults

integer

param maxResults

The maximum number of results to return.

type networkArn

string

param networkArn

[REQUIRED]

The Amazon Resource Name (ARN) of the network.

type startToken

string

param startToken

The token for the next page of results.

rtype

dict

returns

Response Syntax

{
    'networkResources': [
        {
            'attributes': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            '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',
                    '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'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- networkResources (list) --
  
  Information about network resources.
  - (dict) --
    
    Information about a 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.
    - 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.
        
        name (string) --
        
        The recipient's name for this address.
        
        phoneNumber (string) --
        
        The phone number for this address.
        
        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.
- nextToken (string) --
  
  The token for the next page of results.