AWS IoT Wireless

{'LoRaWAN': {'NbTransMax': 'integer',
             'NbTransMin': 'integer',
             'TxPowerIndexMax': 'integer',
             'TxPowerIndexMin': 'integer'}}

Creates a new service profile.

See also: AWS API Documentation

Request Syntax

client.create_service_profile(
    Name='string',
    LoRaWAN={
        'AddGwMetadata': True|False,
        'DrMin': 123,
        'DrMax': 123,
        'PrAllowed': True|False,
        'RaAllowed': True|False,
        'TxPowerIndexMin': 123,
        'TxPowerIndexMax': 123,
        'NbTransMin': 123,
        'NbTransMax': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)

type Name:

string

param Name:

The name of the new resource.

type LoRaWAN:

dict

param LoRaWAN:

The service profile information to use to create the service profile.

• AddGwMetadata (boolean) --

  The AddGWMetaData value.

• DrMin (integer) --

  The DrMin value.

• DrMax (integer) --

  The DrMax value.

• PrAllowed (boolean) --

  The PRAllowed value that describes whether passive roaming is allowed.

• RaAllowed (boolean) --

  The RAAllowed value that describes whether roaming activation is allowed.

• TxPowerIndexMin (integer) --

  The Transmit Power Index minimum.

  Default: 0

• TxPowerIndexMax (integer) --

  The Transmit Power Index maximum.

  Default: 15

• NbTransMin (integer) --

  The minimum number of transmissions.

  Default: 0

• NbTransMax (integer) --

  The maximum number of transmissions.

  Default: 3

type Tags:

list

param Tags:

The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.

• (dict) --

  A simple label consisting of a customer-defined key-value pair

  • Key (string) -- [REQUIRED]

    The tag's key value.

  • Value (string) -- [REQUIRED]

    The tag's value.

type ClientRequestToken:

string

param ClientRequestToken:

Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string'
}

Response Structure

• (dict) --

  • Arn (string) --

    The Amazon Resource Name of the new resource.

  • Id (string) --

    The ID of the new service profile.

{'LoRaWAN': {'NbTransMax': 'integer',
             'NbTransMin': 'integer',
             'TxPowerIndexMax': 'integer',
             'TxPowerIndexMin': 'integer'}}

Gets information about a service profile.

See also: AWS API Documentation

Request Syntax

client.get_service_profile(
    Id='string'
)

type Id:

string

param Id:

[REQUIRED]

The ID of the resource to get.

rtype:

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,
        'TxPowerIndexMin': 123,
        'TxPowerIndexMax': 123,
        'NbTransMin': 123,
        'NbTransMax': 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.

    • TxPowerIndexMin (integer) --

      The Transmit Power Index minimum value.

      Default: 0

    • TxPowerIndexMax (integer) --

      The Transmit Power Index maximum value.

      Default: 15

    • NbTransMin (integer) --

      The minimum number of transmissions.

      Default: 0

    • NbTransMax (integer) --

      The maximum number of transmissions.

      Default: 3