IoTWireless / Client / get_device_profile

get_device_profile

IoTWireless.Client.get_device_profile(**kwargs)

Gets information about a device profile.

See also: AWS API Documentation

Request Syntax

response = client.get_device_profile(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The ID of the resource to get.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string',
    'Id': 'string',
    'LoRaWAN': {
        'SupportsClassB': True|False,
        'ClassBTimeout': 123,
        'PingSlotPeriod': 123,
        'PingSlotDr': 123,
        'PingSlotFreq': 123,
        'SupportsClassC': True|False,
        'ClassCTimeout': 123,
        'MacVersion': 'string',
        'RegParamsRevision': 'string',
        'RxDelay1': 123,
        'RxDrOffset1': 123,
        'RxDataRate2': 123,
        'RxFreq2': 123,
        'FactoryPresetFreqsList': [
            123,
        ],
        'MaxEirp': 123,
        'MaxDutyCycle': 123,
        'RfRegion': 'string',
        'SupportsJoin': True|False,
        'Supports32BitFCnt': True|False
    },
    'Sidewalk': {
        'ApplicationServerPublicKey': 'string',
        'QualificationStatus': True|False,
        'DakCertificateMetadata': [
            {
                'CertificateId': 'string',
                'MaxAllowedSignature': 123,
                'FactorySupport': True|False,
                'ApId': 'string',
                'DeviceTypeId': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name of the resource.

  • Name (string) –

    The name of the resource.

  • Id (string) –

    The ID of the device profile.

  • LoRaWAN (dict) –

    Information about the device profile.

    • SupportsClassB (boolean) –

      The SupportsClassB value.

    • ClassBTimeout (integer) –

      The ClassBTimeout value.

    • PingSlotPeriod (integer) –

      The PingSlotPeriod value.

    • PingSlotDr (integer) –

      The PingSlotDR value.

    • PingSlotFreq (integer) –

      The PingSlotFreq value.

    • SupportsClassC (boolean) –

      The SupportsClassC value.

    • ClassCTimeout (integer) –

      The ClassCTimeout value.

    • MacVersion (string) –

      The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

    • RegParamsRevision (string) –

      The version of regional parameters.

    • RxDelay1 (integer) –

      The RXDelay1 value.

    • RxDrOffset1 (integer) –

      The RXDROffset1 value.

    • RxDataRate2 (integer) –

      The RXDataRate2 value.

    • RxFreq2 (integer) –

      The RXFreq2 value.

    • FactoryPresetFreqsList (list) –

      The list of values that make up the FactoryPresetFreqs value.

      • (integer) –

    • MaxEirp (integer) –

      The MaxEIRP value.

    • MaxDutyCycle (integer) –

      The MaxDutyCycle value. It ranges from 0 to 15.

    • RfRegion (string) –

      The frequency band (RFRegion) value.

    • SupportsJoin (boolean) –

      The SupportsJoin value.

    • Supports32BitFCnt (boolean) –

      The Supports32BitFCnt value.

  • Sidewalk (dict) –

    Information about the Sidewalk parameters in the device profile.

    • ApplicationServerPublicKey (string) –

      The Sidewalk application server public key.

    • QualificationStatus (boolean) –

      Gets information about the certification status of a Sidewalk device profile.

    • DakCertificateMetadata (list) –

      The DAK certificate information of the Sidewalk device profile.

      • (dict) –

        The device attestation key (DAK) information.

        • CertificateId (string) –

          The certificate ID for the DAK.

        • MaxAllowedSignature (integer) –

          The maximum number of signatures that the DAK can sign. A value of -1 indicates that there’s no device limit.

        • FactorySupport (boolean) –

          Whether factory support has been enabled.

        • ApId (string) –

          The advertised product ID (APID) that’s used for pre-production and production applications.

        • DeviceTypeId (string) –

          The device type ID that’s used for prototyping applications.

Exceptions

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.AccessDeniedException

• IoTWireless.Client.exceptions.ResourceNotFoundException

• IoTWireless.Client.exceptions.InternalServerException

• IoTWireless.Client.exceptions.ThrottlingException