IoTWireless / Client / get_service_profile

get_service_profile#

IoTWireless.Client.get_service_profile(**kwargs)#

Gets information about a service profile.

Request Syntax

response = client.get_service_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': {
        'UlRate': 123,
        'UlBucketSize': 123,
        'UlRatePolicy': 'string',
        'DlRate': 123,
        'DlBucketSize': 123,
        'DlRatePolicy': 'string',
        'AddGwMetadata': True|False,
        'DevStatusReqFreq': 123,
        'ReportDevStatusBattery': True|False,
        'ReportDevStatusMargin': True|False,
        'DrMin': 123,
        'DrMax': 123,
        'ChannelMask': 'string',
        'PrAllowed': True|False,
        'HrAllowed': True|False,
        'RaAllowed': True|False,
        'NwkGeoLoc': True|False,
        'TargetPer': 123,
        'MinGwDiversity': 123
    }
}

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 service profile.
- LoRaWAN (dict) –
  
  Information about the service profile.
  - UlRate (integer) –
    
    The ULRate value.
  - UlBucketSize (integer) –
    
    The ULBucketSize value.
  - UlRatePolicy (string) –
    
    The ULRatePolicy value.
  - DlRate (integer) –
    
    The DLRate value.
  - DlBucketSize (integer) –
    
    The DLBucketSize value.
  - DlRatePolicy (string) –
    
    The DLRatePolicy value.
  - AddGwMetadata (boolean) –
    
    The AddGWMetaData value.
  - DevStatusReqFreq (integer) –
    
    The DevStatusReqFreq value.
  - ReportDevStatusBattery (boolean) –
    
    The ReportDevStatusBattery value.
  - ReportDevStatusMargin (boolean) –
    
    The ReportDevStatusMargin value.
  - DrMin (integer) –
    
    The DRMin value.
  - DrMax (integer) –
    
    The DRMax value.
  - ChannelMask (string) –
    
    The ChannelMask value.
  - PrAllowed (boolean) –
    
    The PRAllowed value that describes whether passive roaming is allowed.
  - HrAllowed (boolean) –
    
    The HRAllowed value that describes whether handover roaming is allowed.
  - RaAllowed (boolean) –
    
    The RAAllowed value that describes whether roaming activation is allowed.
  - NwkGeoLoc (boolean) –
    
    The NwkGeoLoc value.
  - TargetPer (integer) –
    
    The TargetPER value.
  - MinGwDiversity (integer) –
    
    The MinGwDiversity value.

Exceptions

IoTWireless.Client.exceptions.ValidationException
IoTWireless.Client.exceptions.AccessDeniedException
IoTWireless.Client.exceptions.ResourceNotFoundException
IoTWireless.Client.exceptions.InternalServerException
IoTWireless.Client.exceptions.ThrottlingException