[ aws . iotwireless ]

get-service-profile

Description

Gets information about a service profile.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-service-profile
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the resource to get.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about a service profile

The following get-service-profile example gets information about the service profile with the specified ID that you created.

aws iotwireless get-service-profile \
    --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d"

Output:

{
    "Arn": "arn:aws:iotwireless:us-east-1:651419225604:ServiceProfile/538185bb-d7e7-4b95-96a0-c51aa4a5b9a0",
    "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d",
    "LoRaWAN": {
        "HrAllowed": false,
        "NwkGeoLoc": false,
        "DrMax": 15,
        "UlBucketSize": 4096,
        "PrAllowed": false,
        "ReportDevStatusBattery": false,
        "DrMin": 0,
        "DlRate": 60,
        "AddGwMetadata": false,
        "ReportDevStatusMargin": false,
        "MinGwDiversity": 1,
        "RaAllowed": false,
        "DlBucketSize": 4096,
        "DevStatusReqFreq": 24,
        "TargetPer": 5,
        "UlRate": 60
    }
}

For more information, see Add profiles to AWS IoT Core for LoRaWAN in the AWS IoT Developers Guide.

Output

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

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.