IoTWireless / Client / create_service_profile

create_service_profile

IoTWireless.Client.create_service_profile(**kwargs)

Creates a new service profile.

See also: AWS API Documentation

Request Syntax

response = 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'
)
Parameters:

  • Name (string) –

    The name of the new resource.

    Note

    The following special characters aren’t accepted: <>^#~$

  • LoRaWAN (dict) –

    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

  • Tags (list) –

    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.

  • ClientRequestToken (string) –

    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.

Return type:

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.

Exceptions