AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotwireless ]

get-device-profile

Description

Gets information about a device profile.

See also: AWS API Documentation

Synopsis

  get-device-profile
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--id (string)

The ID of the resource to get.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get information about a device profile

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

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

Output:

{
    "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d",
    "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d",
    "LoRaWAN": {
    "MacVersion": "1.0.3",
    "MaxDutyCycle": 10,
    "Supports32BitFCnt": false,
    "RegParamsRevision": "RP002-1.0.1",
    "SupportsJoin": true,
    "RfRegion": "US915",
    "MaxEirp": 13,
    "SupportsClassB": false,
    "SupportsClassC": false
    }
}

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 device profile.

LoRaWAN -> (structure)

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

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.

(structure)

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.