get_network_resource

Private5G.Client.get_network_resource(**kwargs)

Gets the specified network resource.

See also: AWS API Documentation

Request Syntax

response = client.get_network_resource(
    networkResourceArn='string'
)

Parameters

networkResourceArn (string) --

[REQUIRED]

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

Return type

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) --

Exceptions

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