IoTWireless

Table of Contents

Client

class IoTWireless.Client

A low-level client representing AWS IoT Wireless

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.

Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.

You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.

import boto3

client = boto3.client('iotwireless')

These are the available methods:

associate_aws_account_with_partner_account(**kwargs)

Associates a partner account with your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.associate_aws_account_with_partner_account(
    Sidewalk={
        'AmazonId': 'string',
        'AppServerPrivateKey': 'string'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Sidewalk (dict) --

    [REQUIRED]

    The Sidewalk account credentials.

    • AmazonId (string) --

      The Sidewalk Amazon ID.

    • AppServerPrivateKey (string) --

      The Sidewalk application server private key.

  • ClientRequestToken (string) --

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags to attach to the specified resource. 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.

Return type

dict

Returns

Response Syntax

{
    'Sidewalk': {
        'AmazonId': 'string',
        'AppServerPrivateKey': 'string'
    },
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Sidewalk (dict) --

      The Sidewalk account credentials.

      • AmazonId (string) --

        The Sidewalk Amazon ID.

      • AppServerPrivateKey (string) --

        The Sidewalk application server private key.

    • Arn (string) --

      The Amazon Resource Name of the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.AccessDeniedException
associate_multicast_group_with_fuota_task(**kwargs)

Associate a multicast group with a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.associate_multicast_group_with_fuota_task(
    Id='string',
    MulticastGroupId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • MulticastGroupId (string) --

    [REQUIRED]

    The ID of the multicast group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
associate_wireless_device_with_fuota_task(**kwargs)

Associate a wireless device with a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.associate_wireless_device_with_fuota_task(
    Id='string',
    WirelessDeviceId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • WirelessDeviceId (string) --

    [REQUIRED]

    The ID of the wireless device.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
associate_wireless_device_with_multicast_group(**kwargs)

Associates a wireless device with a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.associate_wireless_device_with_multicast_group(
    Id='string',
    WirelessDeviceId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • WirelessDeviceId (string) --

    [REQUIRED]

    The ID of the wireless device.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
associate_wireless_device_with_thing(**kwargs)

Associates a wireless device with a thing.

See also: AWS API Documentation

Request Syntax

response = client.associate_wireless_device_with_thing(
    Id='string',
    ThingArn='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the resource to update.

  • ThingArn (string) --

    [REQUIRED]

    The ARN of the thing to associate with the wireless device.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
associate_wireless_gateway_with_certificate(**kwargs)

Associates a wireless gateway with a certificate.

See also: AWS API Documentation

Request Syntax

response = client.associate_wireless_gateway_with_certificate(
    Id='string',
    IotCertificateId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the resource to update.

  • IotCertificateId (string) --

    [REQUIRED]

    The ID of the certificate to associate with the wireless gateway.

Return type

dict

Returns

Response Syntax

{
    'IotCertificateId': 'string'
}

Response Structure

  • (dict) --

    • IotCertificateId (string) --

      The ID of the certificate associated with the wireless gateway.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
associate_wireless_gateway_with_thing(**kwargs)

Associates a wireless gateway with a thing.

See also: AWS API Documentation

Request Syntax

response = client.associate_wireless_gateway_with_thing(
    Id='string',
    ThingArn='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the resource to update.

  • ThingArn (string) --

    [REQUIRED]

    The ARN of the thing to associate with the wireless gateway.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_multicast_group_session(**kwargs)

Cancels an existing multicast group session.

See also: AWS API Documentation

Request Syntax

response = client.cancel_multicast_group_session(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the multicast group.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_destination(**kwargs)

Creates a new destination that maps a device message to an AWS IoT rule.

See also: AWS API Documentation

Request Syntax

response = client.create_destination(
    Name='string',
    ExpressionType='RuleName'|'MqttTopic',
    Expression='string',
    Description='string',
    RoleArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the new resource.

  • ExpressionType (string) --

    [REQUIRED]

    The type of value in Expression .

  • Expression (string) --

    [REQUIRED]

    The rule name or topic rule to send messages to.

  • Description (string) -- The description of the new resource.
  • RoleArn (string) --

    [REQUIRED]

    The ARN of the IAM Role that authorizes the destination.

  • Tags (list) --

    The tags to attach to the new destination. 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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name of the new resource.

    • Name (string) --

      The name of the new resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_device_profile(**kwargs)

Creates a new device profile.

See also: AWS API Documentation

Request Syntax

response = client.create_device_profile(
    Name='string',
    LoRaWAN={
        'SupportsClassB': True|False,
        'ClassBTimeout': 123,
        'PingSlotPeriod': 123,
        'PingSlotDr': 123,
        'PingSlotFreq': 123,
        'SupportsClassC': True|False,
        'ClassCTimeout': 123,
        'MacVersion': 'string',
        'RegParamsRevision': 'string',
        'RxDelay1': 123,
        'RxDrOffset1': 123,
        'RxDataRate2': 123,
        'RxFreq2': 123,
        'FactoryPresetFreqsList': [
            123,
        ],
        'MaxEirp': 123,
        'MaxDutyCycle': 123,
        'RfRegion': 'string',
        'SupportsJoin': True|False,
        'Supports32BitFCnt': True|False
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
Parameters
  • Name (string) -- The name of the new resource.
  • LoRaWAN (dict) --

    The device profile information to use to create 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.

    • RfRegion (string) --

      The frequency band (RFRegion) value.

    • SupportsJoin (boolean) --

      The SupportsJoin value.

    • Supports32BitFCnt (boolean) --

      The Supports32BitFCnt value.

  • Tags (list) --

    The tags to attach to the new device 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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

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

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_fuota_task(**kwargs)

Creates a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.create_fuota_task(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'
    },
    FirmwareUpdateImage='string',
    FirmwareUpdateRole='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Name (string) -- The name of a FUOTA task.
  • Description (string) -- The description of the new resource.
  • ClientRequestToken (string) --

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

  • LoRaWAN (dict) --

    The LoRaWAN information used with a FUOTA task.

    • RfRegion (string) --

      Supported RfRegions

  • FirmwareUpdateImage (string) --

    [REQUIRED]

    The S3 URI points to a firmware update image that is to be used with a FUOTA task.

  • FirmwareUpdateRole (string) --

    [REQUIRED]

    The firmware update role that is to be used with a FUOTA task.

  • Tags (list) --

    The tag to attach to the specified resource. 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.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Arn (string) --

      The arn of a FUOTA task.

    • Id (string) --

      The ID of a FUOTA task.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_multicast_group(**kwargs)

Creates a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.create_multicast_group(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
        'DlClass': 'ClassB'|'ClassC'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Name (string) -- The name of the multicast group.
  • Description (string) -- The description of the multicast group.
  • ClientRequestToken (string) --

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

  • LoRaWAN (dict) --

    [REQUIRED]

    The LoRaWAN information that is to be used with the multicast group.

    • RfRegion (string) --

      Supported RfRegions

    • DlClass (string) --

      DlClass for LoRaWAM, valid values are ClassB and ClassC.

  • Tags (list) --

    The tag to attach to the specified resource. 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.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Arn (string) --

      The arn of the multicast group.

    • Id (string) --

      The ID of the multicast group.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_network_analyzer_configuration(**kwargs)

Creates a new network analyzer configuration.

See also: AWS API Documentation

Request Syntax

response = client.create_network_analyzer_configuration(
    Name='string',
    TraceContent={
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED'
    },
    WirelessDevices=[
        'string',
    ],
    WirelessGateways=[
        'string',
    ],
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    Name of the network analyzer configuration.

  • TraceContent (dict) --

    Trace content for your wireless gateway and wireless device resources.

    • WirelessDeviceFrameInfo (string) --

      FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

    • LogLevel (string) --

      The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

  • WirelessDevices (list) --

    Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

    • (string) --

      The ID of the wireless device.

  • WirelessGateways (list) --

    Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

    • (string) --
  • Description (string) -- The description of the new resource.
  • Tags (list) --

    The tag to attach to the specified resource. 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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name of the new resource.

    • Name (string) --

      Name of the network analyzer configuration.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
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
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
Parameters
  • Name (string) -- The name of the new resource.
  • LoRaWAN (dict) --

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

    • AddGwMetadata (boolean) --

      The AddGWMetaData value.

  • 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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_wireless_device(**kwargs)

Provisions a wireless device.

See also: AWS API Documentation

Request Syntax

response = client.create_wireless_device(
    Type='Sidewalk'|'LoRaWAN',
    Name='string',
    Description='string',
    DestinationName='string',
    ClientRequestToken='string',
    LoRaWAN={
        'DevEui': 'string',
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'OtaaV1_1': {
            'AppKey': 'string',
            'NwkKey': 'string',
            'JoinEui': 'string'
        },
        'OtaaV1_0_x': {
            'AppKey': 'string',
            'AppEui': 'string',
            'GenAppKey': 'string'
        },
        'AbpV1_1': {
            'DevAddr': 'string',
            'SessionKeys': {
                'FNwkSIntKey': 'string',
                'SNwkSIntKey': 'string',
                'NwkSEncKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'AbpV1_0_x': {
            'DevAddr': 'string',
            'SessionKeys': {
                'NwkSKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'FPorts': {
            'Fuota': 123,
            'Multicast': 123,
            'ClockSync': 123
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Type (string) --

    [REQUIRED]

    The wireless device type.

  • Name (string) -- The name of the new resource.
  • Description (string) -- The description of the new resource.
  • DestinationName (string) --

    [REQUIRED]

    The name of the destination to assign to the new wireless device.

  • ClientRequestToken (string) --

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

  • LoRaWAN (dict) --

    The device configuration information to use to create the wireless device.

    • DevEui (string) --

      The DevEUI value.

    • DeviceProfileId (string) --

      The ID of the device profile for the new wireless device.

    • ServiceProfileId (string) --

      The ID of the service profile.

    • OtaaV1_1 (dict) --

      OTAA device object for v1.1 for create APIs

      • AppKey (string) --

        The AppKey value.

      • NwkKey (string) --

        The NwkKey value.

      • JoinEui (string) --

        The JoinEUI value.

    • OtaaV1_0_x (dict) --

      OTAA device object for create APIs for v1.0.x

      • AppKey (string) --

        The AppKey value.

      • AppEui (string) --

        The AppEUI value.

      • GenAppKey (string) --

        The GenAppKey value.

    • AbpV1_1 (dict) --

      ABP device object for create APIs for v1.1

      • DevAddr (string) --

        The DevAddr value.

      • SessionKeys (dict) --

        Session keys for ABP v1.1

        • FNwkSIntKey (string) --

          The FNwkSIntKey value.

        • SNwkSIntKey (string) --

          The SNwkSIntKey value.

        • NwkSEncKey (string) --

          The NwkSEncKey value.

        • AppSKey (string) --

          The AppSKey value.

      • FCntStart (integer) --

        The FCnt init value.

    • AbpV1_0_x (dict) --

      LoRaWAN object for create APIs

      • DevAddr (string) --

        The DevAddr value.

      • SessionKeys (dict) --

        Session keys for ABP v1.0.x

        • NwkSKey (string) --

          The NwkSKey value.

        • AppSKey (string) --

          The AppSKey value.

      • FCntStart (integer) --

        The FCnt init value.

    • FPorts (dict) --

      List of FPort assigned for different LoRaWAN application packages to use

      • Fuota (integer) --

        The Fport value.

      • Multicast (integer) --

        The Fport value.

      • ClockSync (integer) --

        The Fport value.

  • Tags (list) --

    The tags to attach to the new wireless device. 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.

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

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_wireless_gateway(**kwargs)

Provisions a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.create_wireless_gateway(
    Name='string',
    Description='string',
    LoRaWAN={
        'GatewayEui': 'string',
        'RfRegion': 'string',
        'JoinEuiFilters': [
            [
                'string',
            ],
        ],
        'NetIdFilters': [
            'string',
        ],
        'SubBands': [
            123,
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string'
)
Parameters
  • Name (string) -- The name of the new resource.
  • Description (string) -- The description of the new resource.
  • LoRaWAN (dict) --

    [REQUIRED]

    The gateway configuration information to use to create the wireless gateway.

    • GatewayEui (string) --

      The gateway's EUI value.

    • RfRegion (string) --

      The frequency band (RFRegion) value.

    • JoinEuiFilters (list) --

      A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

      • (list) --

        A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.

        • (string) --
    • NetIdFilters (list) --

      A list of NetId values that are used by LoRa gateways to filter the uplink frames.

      • (string) --

        LoRaWAN network ID.

    • SubBands (list) --

      A list of integer indicating which sub bands are supported by LoRa gateway.

      • (integer) --

        A subset of supported frequency channels in a certain RFRegion.

  • Tags (list) --

    The tags to attach to the new wireless gateway. 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. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    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 wireless gateway.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_wireless_gateway_task(**kwargs)

Creates a task for a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.create_wireless_gateway_task(
    Id='string',
    WirelessGatewayTaskDefinitionId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the resource to update.

  • WirelessGatewayTaskDefinitionId (string) --

    [REQUIRED]

    The ID of the WirelessGatewayTaskDefinition.

Return type

dict

Returns

Response Syntax

{
    'WirelessGatewayTaskDefinitionId': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}

Response Structure

  • (dict) --

    • WirelessGatewayTaskDefinitionId (string) --

      The ID of the WirelessGatewayTaskDefinition.

    • Status (string) --

      The status of the request.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
create_wireless_gateway_task_definition(**kwargs)

Creates a gateway task definition.

See also: AWS API Documentation

Request Syntax

response = client.create_wireless_gateway_task_definition(
    AutoCreateTasks=True|False,
    Name='string',
    Update={
        'UpdateDataSource': 'string',
        'UpdateDataRole': 'string',
        'LoRaWAN': {
            'UpdateSignature': 'string',
            'SigKeyCrc': 123,
            'CurrentVersion': {
                'PackageVersion': 'string',
                'Model': 'string',
                'Station': 'string'
            },
            'UpdateVersion': {
                'PackageVersion': 'string',
                'Model': 'string',
                'Station': 'string'
            }
        }
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • AutoCreateTasks (boolean) --

    [REQUIRED]

    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false , the task must me created by calling CreateWirelessGatewayTask .

  • Name (string) -- The name of the new resource.
  • Update (dict) --

    Information about the gateways to update.

    • UpdateDataSource (string) --

      The link to the S3 bucket.

    • UpdateDataRole (string) --

      The IAM role used to read data from the S3 bucket.

    • LoRaWAN (dict) --

      The properties that relate to the LoRaWAN wireless gateway.

      • UpdateSignature (string) --

        The signature used to verify the update firmware.

      • SigKeyCrc (integer) --

        The CRC of the signature private key to check.

      • CurrentVersion (dict) --

        The version of the gateways that should receive the update.

        • PackageVersion (string) --

          The version of the wireless gateway firmware.

        • Model (string) --

          The model number of the wireless gateway.

        • Station (string) --

          The basic station version of the wireless gateway.

      • UpdateVersion (dict) --

        The firmware version to update the gateway to.

        • PackageVersion (string) --

          The version of the wireless gateway firmware.

        • Model (string) --

          The model number of the wireless gateway.

        • Station (string) --

          The basic station version of the wireless gateway.

  • ClientRequestToken (string) --

    Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

    This field is autopopulated if not provided.

  • Tags (list) --

    The tags to attach to the specified resource. 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.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Id (string) --

      The ID of the new wireless gateway task definition.

    • Arn (string) --

      The Amazon Resource Name of the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_destination(**kwargs)

Deletes a destination.

See also: AWS API Documentation

Request Syntax

response = client.delete_destination(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_device_profile(**kwargs)

Deletes a device profile.

See also: AWS API Documentation

Request Syntax

response = client.delete_device_profile(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_fuota_task(**kwargs)

Deletes a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.delete_fuota_task(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of a FUOTA task.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_multicast_group(**kwargs)

Deletes a multicast group if it is not in use by a fuota task.

See also: AWS API Documentation

Request Syntax

response = client.delete_multicast_group(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the multicast group.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_network_analyzer_configuration(**kwargs)

Deletes a network analyzer configuration.

See also: AWS API Documentation

Request Syntax

response = client.delete_network_analyzer_configuration(
    ConfigurationName='string'
)
Parameters
ConfigurationName (string) --

[REQUIRED]

Name of the network analyzer configuration.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_queued_messages(**kwargs)

Remove queued messages from the downlink queue.

See also: AWS API Documentation

Request Syntax

response = client.delete_queued_messages(
    Id='string',
    MessageId='string',
    WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a given wireless device for which downlink messages will be deleted.

  • MessageId (string) --

    [REQUIRED]

    If message ID is "*" , it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

  • WirelessDeviceType (string) -- The wireless device type, which can be either Sidewalk or LoRaWAN.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.AccessDeniedException
delete_service_profile(**kwargs)

Deletes a service profile.

See also: AWS API Documentation

Request Syntax

response = client.delete_service_profile(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_wireless_device(**kwargs)

Deletes a wireless device.

See also: AWS API Documentation

Request Syntax

response = client.delete_wireless_device(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_wireless_gateway(**kwargs)

Deletes a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.delete_wireless_gateway(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_wireless_gateway_task(**kwargs)

Deletes a wireless gateway task.

See also: AWS API Documentation

Request Syntax

response = client.delete_wireless_gateway_task(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
delete_wireless_gateway_task_definition(**kwargs)

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

See also: AWS API Documentation

Request Syntax

response = client.delete_wireless_gateway_task_definition(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
disassociate_aws_account_from_partner_account(**kwargs)

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null , disassociates your AWS account from all partner accounts.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_aws_account_from_partner_account(
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)
Parameters
  • PartnerAccountId (string) --

    [REQUIRED]

    The partner account ID to disassociate from the AWS account.

  • PartnerType (string) --

    [REQUIRED]

    The partner type.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
disassociate_multicast_group_from_fuota_task(**kwargs)

Disassociates a multicast group from a fuota task.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_multicast_group_from_fuota_task(
    Id='string',
    MulticastGroupId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • MulticastGroupId (string) --

    [REQUIRED]

    The ID of the multicast group.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
disassociate_wireless_device_from_fuota_task(**kwargs)

Disassociates a wireless device from a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_wireless_device_from_fuota_task(
    Id='string',
    WirelessDeviceId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • WirelessDeviceId (string) --

    [REQUIRED]

    The ID of the wireless device.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
disassociate_wireless_device_from_multicast_group(**kwargs)

Disassociates a wireless device from a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_wireless_device_from_multicast_group(
    Id='string',
    WirelessDeviceId='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • WirelessDeviceId (string) --

    [REQUIRED]

    The ID of the wireless device.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
disassociate_wireless_device_from_thing(**kwargs)

Disassociates a wireless device from its currently associated thing.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_wireless_device_from_thing(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to update.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
disassociate_wireless_gateway_from_certificate(**kwargs)

Disassociates a wireless gateway from its currently associated certificate.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_wireless_gateway_from_certificate(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to update.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
disassociate_wireless_gateway_from_thing(**kwargs)

Disassociates a wireless gateway from its currently associated thing.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_wireless_gateway_from_thing(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to update.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
get_destination(**kwargs)

Gets information about a destination.

See also: AWS API Documentation

Request Syntax

response = client.get_destination(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the resource to get.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Name': 'string',
    'Expression': 'string',
    'ExpressionType': 'RuleName'|'MqttTopic',
    'Description': 'string',
    'RoleArn': 'string'
}

Response Structure

  • (dict) --
    • Arn (string) --

      The Amazon Resource Name of the resource.

    • Name (string) --

      The name of the resource.

    • Expression (string) --

      The rule name or topic rule to send messages to.

    • ExpressionType (string) --

      The type of value in Expression .

    • Description (string) --

      The description of the resource.

    • RoleArn (string) --

      The ARN of the IAM Role that authorizes the destination.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_device_profile(**kwargs)

Gets information about a device profile.

See also: AWS API Documentation

Request Syntax

response = client.get_device_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': {
        'SupportsClassB': True|False,
        'ClassBTimeout': 123,
        'PingSlotPeriod': 123,
        'PingSlotDr': 123,
        'PingSlotFreq': 123,
        'SupportsClassC': True|False,
        'ClassCTimeout': 123,
        'MacVersion': 'string',
        'RegParamsRevision': 'string',
        'RxDelay1': 123,
        'RxDrOffset1': 123,
        'RxDataRate2': 123,
        'RxFreq2': 123,
        'FactoryPresetFreqsList': [
            123,
        ],
        'MaxEirp': 123,
        'MaxDutyCycle': 123,
        'RfRegion': 'string',
        'SupportsJoin': True|False,
        'Supports32BitFCnt': True|False
    }
}

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

    • LoRaWAN (dict) --

      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.

      • RfRegion (string) --

        The frequency band (RFRegion) value.

      • SupportsJoin (boolean) --

        The SupportsJoin value.

      • Supports32BitFCnt (boolean) --

        The Supports32BitFCnt value.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_event_configuration_by_resource_types()

Get the event configuration by resource types.

See also: AWS API Documentation

Request Syntax

response = client.get_event_configuration_by_resource_types()
Return type
dict
Returns
Response Syntax
{
    'DeviceRegistrationState': {
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    'Proximity': {
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    'Join': {
        'LoRaWAN': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    'ConnectionStatus': {
        'LoRaWAN': {
            'WirelessGatewayEventTopic': 'Enabled'|'Disabled'
        }
    }
}

Response Structure

  • (dict) --
    • DeviceRegistrationState (dict) --

      Resource type event configuration for the device registration state event

      • Sidewalk (dict) --

        Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.

        • WirelessDeviceEventTopic (string) --

          Enum to denote whether the wireless device join event topic is enabled or disabled.

    • Proximity (dict) --

      Resource type event configuration for the proximity event

      • Sidewalk (dict) --

        Proximity resource type event configuration object for enabling and disabling wireless device topic.

        • WirelessDeviceEventTopic (string) --

          Enum to denote whether the wireless device join event topic is enabled or disabled.

    • Join (dict) --

      Resource type event configuration for the join event

      • LoRaWAN (dict) --

        Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.

        • WirelessDeviceEventTopic (string) --

          Enum to denote whether the wireless device join event topic is enabled or disabled.

    • ConnectionStatus (dict) --

      Resource type event configuration for the connection status event

      • LoRaWAN (dict) --

        Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.

        • WirelessGatewayEventTopic (string) --

          Enum to denote whether the wireless gateway connection status event topic is enabled or disabled.

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
get_fuota_task(**kwargs)

Gets information about a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.get_fuota_task(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of a FUOTA task.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Id': 'string',
    'Status': 'Pending'|'FuotaSession_Waiting'|'In_FuotaSession'|'FuotaDone'|'Delete_Waiting',
    'Name': 'string',
    'Description': 'string',
    'LoRaWAN': {
        'RfRegion': 'string',
        'StartTime': datetime(2015, 1, 1)
    },
    'FirmwareUpdateImage': 'string',
    'FirmwareUpdateRole': 'string',
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • Arn (string) --

      The arn of a FUOTA task.

    • Id (string) --

      The ID of a FUOTA task.

    • Status (string) --

      The status of a FUOTA task.

    • Name (string) --

      The name of a FUOTA task.

    • Description (string) --

      The description of the new resource.

    • LoRaWAN (dict) --

      The LoRaWAN information returned from getting a FUOTA task.

      • RfRegion (string) --

        The frequency band (RFRegion) value.

      • StartTime (datetime) --

        Start time of a FUOTA task.

    • FirmwareUpdateImage (string) --

      The S3 URI points to a firmware update image that is to be used with a FUOTA task.

    • FirmwareUpdateRole (string) --

      The firmware update role that is to be used with a FUOTA task.

    • CreatedAt (datetime) --

      Created at timestamp for the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_log_levels_by_resource_types()

Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.

See also: AWS API Documentation

Request Syntax

response = client.get_log_levels_by_resource_types()
Return type
dict
Returns
Response Syntax
{
    'DefaultLogLevel': 'INFO'|'ERROR'|'DISABLED',
    'WirelessGatewayLogOptions': [
        {
            'Type': 'LoRaWAN',
            'LogLevel': 'INFO'|'ERROR'|'DISABLED',
            'Events': [
                {
                    'Event': 'CUPS_Request'|'Certificate',
                    'LogLevel': 'INFO'|'ERROR'|'DISABLED'
                },
            ]
        },
    ],
    'WirelessDeviceLogOptions': [
        {
            'Type': 'Sidewalk'|'LoRaWAN',
            'LogLevel': 'INFO'|'ERROR'|'DISABLED',
            'Events': [
                {
                    'Event': 'Join'|'Rejoin'|'Uplink_Data'|'Downlink_Data'|'Registration',
                    'LogLevel': 'INFO'|'ERROR'|'DISABLED'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • DefaultLogLevel (string) --

      The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

    • WirelessGatewayLogOptions (list) --

      The list of wireless gateway log options.

      • (dict) --

        The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.

        • Type (string) --

          The wireless gateway type.

        • LogLevel (string) --

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        • Events (list) --

          The list of wireless gateway event log options.

          • (dict) --

            The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.

            For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate .

            • Event (string) --

              The event for a log message, if the log message is tied to a wireless gateway.

            • LogLevel (string) --

              The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

    • WirelessDeviceLogOptions (list) --

      The list of wireless device log options.

      • (dict) --

        The log options for wireless devices and can be used to set log levels for a specific type of wireless device.

        • Type (string) --

          The wireless device type.

        • LogLevel (string) --

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        • Events (list) --

          The list of wireless device event log options.

          • (dict) --

            The log options for a wireless device event and can be used to set log levels for a specific wireless device event.

            For a LoRaWAN device, possible events for a log messsage are: Join , Rejoin , Downlink_Data , and Uplink_Data . For a Sidewalk device, possible events for a log message are Registration , Downlink_Data , and Uplink_Data .

            • Event (string) --

              The event for a log message, if the log message is tied to a wireless device.

            • LogLevel (string) --

              The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ValidationException
get_multicast_group(**kwargs)

Gets information about a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.get_multicast_group(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the multicast group.

Return type
dict
Returns
Response Syntax
{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'Status': 'string',
    'LoRaWAN': {
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
        'DlClass': 'ClassB'|'ClassC',
        'NumberOfDevicesRequested': 123,
        'NumberOfDevicesInGroup': 123
    },
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • Arn (string) --

      The arn of the multicast group.

    • Id (string) --

      The ID of the multicast group.

    • Name (string) --

      The name of the multicast group.

    • Description (string) --

      The description of the new resource.

    • Status (string) --

      The status of the multicast group.

    • LoRaWAN (dict) --

      The LoRaWAN information that is to be returned from getting multicast group information.

      • RfRegion (string) --

        Supported RfRegions

      • DlClass (string) --

        DlClass for LoRaWAM, valid values are ClassB and ClassC.

      • NumberOfDevicesRequested (integer) --

        Number of devices that are requested to be associated with the multicast group.

      • NumberOfDevicesInGroup (integer) --

        Number of devices that are associated to the multicast group.

    • CreatedAt (datetime) --

      Created at timestamp for the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_multicast_group_session(**kwargs)

Gets information about a multicast group session.

See also: AWS API Documentation

Request Syntax

response = client.get_multicast_group_session(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the multicast group.

Return type
dict
Returns
Response Syntax
{
    'LoRaWAN': {
        'DlDr': 123,
        'DlFreq': 123,
        'SessionStartTime': datetime(2015, 1, 1),
        'SessionTimeout': 123
    }
}

Response Structure

  • (dict) --
    • LoRaWAN (dict) --

      The LoRaWAN information used with the multicast session.

      • DlDr (integer) --

        Downlink data rate.

      • DlFreq (integer) --

        Downlink frequency.

      • SessionStartTime (datetime) --

        Timestamp of when the multicast group session is to start.

      • SessionTimeout (integer) --

        How long before a multicast group session is to timeout.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_network_analyzer_configuration(**kwargs)

Get network analyzer configuration.

See also: AWS API Documentation

Request Syntax

response = client.get_network_analyzer_configuration(
    ConfigurationName='string'
)
Parameters
ConfigurationName (string) --

[REQUIRED]

Name of the network analyzer configuration.

Return type
dict
Returns
Response Syntax
{
    'TraceContent': {
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED'
    },
    'WirelessDevices': [
        'string',
    ],
    'WirelessGateways': [
        'string',
    ],
    'Description': 'string',
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) --
    • TraceContent (dict) --

      Trace content for your wireless gateway and wireless device resources.

      • WirelessDeviceFrameInfo (string) --

        FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

      • LogLevel (string) --

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

    • WirelessDevices (list) --

      List of wireless gateway resources that have been added to the network analyzer configuration.

      • (string) --

        The ID of the wireless device.

    • WirelessGateways (list) --

      List of wireless gateway resources that have been added to the network analyzer configuration.

      • (string) --
    • Description (string) --

      The description of the new resource.

    • Arn (string) --

      The Amazon Resource Name of the new resource.

    • Name (string) --

      Name of the network analyzer configuration.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_partner_account(**kwargs)

Gets information about a partner account. If PartnerAccountId and PartnerType are null , returns all partner accounts.

See also: AWS API Documentation

Request Syntax

response = client.get_partner_account(
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)
Parameters
  • PartnerAccountId (string) --

    [REQUIRED]

    The partner account ID to disassociate from the AWS account.

  • PartnerType (string) --

    [REQUIRED]

    The partner type.

Return type

dict

Returns

Response Syntax

{
    'Sidewalk': {
        'AmazonId': 'string',
        'Fingerprint': 'string',
        'Arn': 'string'
    },
    'AccountLinked': True|False
}

Response Structure

  • (dict) --

    • Sidewalk (dict) --

      The Sidewalk account credentials.

      • AmazonId (string) --

        The Sidewalk Amazon ID.

      • Fingerprint (string) --

        The fingerprint of the Sidewalk application server private key.

      • Arn (string) --

        The Amazon Resource Name of the resource.

    • AccountLinked (boolean) --

      Whether the partner account is linked to the AWS account.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_resource_event_configuration(**kwargs)

Get the event configuration for a particular resource identifier.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_event_configuration(
    Identifier='string',
    IdentifierType='PartnerAccountId'|'DevEui'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
    PartnerType='Sidewalk'
)
Parameters
  • Identifier (string) --

    [REQUIRED]

    Resource identifier to opt in for event messaging.

  • IdentifierType (string) --

    [REQUIRED]

    Identifier type of the particular resource identifier for event configuration.

  • PartnerType (string) -- Partner type of the resource if the identifier type is PartnerAccountId.
Return type

dict

Returns

Response Syntax

{
    'DeviceRegistrationState': {
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    'Proximity': {
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    'Join': {
        'LoRaWAN': {
            'DevEuiEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    'ConnectionStatus': {
        'LoRaWAN': {
            'GatewayEuiEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
    }
}

Response Structure

  • (dict) --

    • DeviceRegistrationState (dict) --

      Event configuration for the device registration state event

      • Sidewalk (dict) --

        Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

        • AmazonIdEventTopic (string) --

          Enum to denote whether amazon id event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) --

        Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

    • Proximity (dict) --

      Event configuration for the Proximity event

      • Sidewalk (dict) --

        Proximity event configuration object for enabling or disabling Sidewalk related event topics.

        • AmazonIdEventTopic (string) --

          Enum to denote whether amazon id event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) --

        Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

    • Join (dict) --

      Event configuration for the join event.

      • LoRaWAN (dict) --

        Join event configuration object for enabling or disabling LoRaWAN related event topics.

        • DevEuiEventTopic (string) --

          Enum to denote whether the dev eui join event topic is enabled or disabled.

      • WirelessDeviceIdEventTopic (string) --

        Enum to denote whether the wireless device id join event topic is enabled or disabled.

    • ConnectionStatus (dict) --

      Event configuration for the connection status event.

      • LoRaWAN (dict) --

        Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

        • GatewayEuiEventTopic (string) --

          Enum to denote whether the gateway eui connection status event topic is enabled or disabled.

      • WirelessGatewayIdEventTopic (string) --

        Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
get_resource_log_level(**kwargs)

Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_resource_log_level(
    ResourceIdentifier='string',
    ResourceType='string'
)
Parameters
  • ResourceIdentifier (string) --

    [REQUIRED]

    The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

  • ResourceType (string) --

    [REQUIRED]

    The type of the resource, which can be WirelessDevice or WirelessGateway .

Return type

dict

Returns

Response Syntax

{
    'LogLevel': 'INFO'|'ERROR'|'DISABLED'
}

Response Structure

  • (dict) --

    • LogLevel (string) --

      The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ValidationException
get_service_endpoint(**kwargs)

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

See also: AWS API Documentation

Request Syntax

response = client.get_service_endpoint(
    ServiceType='CUPS'|'LNS'
)
Parameters
ServiceType (string) -- The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the global endpoint.
Return type
dict
Returns
Response Syntax
{
    'ServiceType': 'CUPS'|'LNS',
    'ServiceEndpoint': 'string',
    'ServerTrust': 'string'
}

Response Structure

  • (dict) --
    • ServiceType (string) --

      The endpoint's service type.

    • ServiceEndpoint (string) --

      The service endpoint value.

    • ServerTrust (string) --

      The Root CA of the server trust certificate.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_service_profile(**kwargs)

Gets information about a service profile.

See also: AWS API Documentation

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
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
get_wireless_device(**kwargs)

Gets information about a wireless device.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_device(
    Identifier='string',
    IdentifierType='WirelessDeviceId'|'DevEui'|'ThingName'|'SidewalkManufacturingSn'
)
Parameters
  • Identifier (string) --

    [REQUIRED]

    The identifier of the wireless device to get.

  • IdentifierType (string) --

    [REQUIRED]

    The type of identifier used in identifier .

Return type

dict

Returns

Response Syntax

{
    'Type': 'Sidewalk'|'LoRaWAN',
    'Name': 'string',
    'Description': 'string',
    'DestinationName': 'string',
    'Id': 'string',
    'Arn': 'string',
    'ThingName': 'string',
    'ThingArn': 'string',
    'LoRaWAN': {
        'DevEui': 'string',
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'OtaaV1_1': {
            'AppKey': 'string',
            'NwkKey': 'string',
            'JoinEui': 'string'
        },
        'OtaaV1_0_x': {
            'AppKey': 'string',
            'AppEui': 'string',
            'GenAppKey': 'string'
        },
        'AbpV1_1': {
            'DevAddr': 'string',
            'SessionKeys': {
                'FNwkSIntKey': 'string',
                'SNwkSIntKey': 'string',
                'NwkSEncKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'AbpV1_0_x': {
            'DevAddr': 'string',
            'SessionKeys': {
                'NwkSKey': 'string',
                'AppSKey': 'string'
            },
            'FCntStart': 123
        },
        'FPorts': {
            'Fuota': 123,
            'Multicast': 123,
            'ClockSync': 123
        }
    },
    'Sidewalk': {
        'AmazonId': 'string',
        'SidewalkId': 'string',
        'SidewalkManufacturingSn': 'string',
        'DeviceCertificates': [
            {
                'SigningAlg': 'Ed25519'|'P256r1',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Type (string) --

      The wireless device type.

    • Name (string) --

      The name of the resource.

    • Description (string) --

      The description of the resource.

    • DestinationName (string) --

      The name of the destination to which the device is assigned.

    • Id (string) --

      The ID of the wireless device.

    • Arn (string) --

      The Amazon Resource Name of the resource.

    • ThingName (string) --

      The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.

    • ThingArn (string) --

      The ARN of the thing associated with the wireless device.

    • LoRaWAN (dict) --

      Information about the wireless device.

      • DevEui (string) --

        The DevEUI value.

      • DeviceProfileId (string) --

        The ID of the device profile for the new wireless device.

      • ServiceProfileId (string) --

        The ID of the service profile.

      • OtaaV1_1 (dict) --

        OTAA device object for v1.1 for create APIs

        • AppKey (string) --

          The AppKey value.

        • NwkKey (string) --

          The NwkKey value.

        • JoinEui (string) --

          The JoinEUI value.

      • OtaaV1_0_x (dict) --

        OTAA device object for create APIs for v1.0.x

        • AppKey (string) --

          The AppKey value.

        • AppEui (string) --

          The AppEUI value.

        • GenAppKey (string) --

          The GenAppKey value.

      • AbpV1_1 (dict) --

        ABP device object for create APIs for v1.1

        • DevAddr (string) --

          The DevAddr value.

        • SessionKeys (dict) --

          Session keys for ABP v1.1

          • FNwkSIntKey (string) --

            The FNwkSIntKey value.

          • SNwkSIntKey (string) --

            The SNwkSIntKey value.

          • NwkSEncKey (string) --

            The NwkSEncKey value.

          • AppSKey (string) --

            The AppSKey value.

        • FCntStart (integer) --

          The FCnt init value.

      • AbpV1_0_x (dict) --

        LoRaWAN object for create APIs

        • DevAddr (string) --

          The DevAddr value.

        • SessionKeys (dict) --

          Session keys for ABP v1.0.x

          • NwkSKey (string) --

            The NwkSKey value.

          • AppSKey (string) --

            The AppSKey value.

        • FCntStart (integer) --

          The FCnt init value.

      • FPorts (dict) --

        List of FPort assigned for different LoRaWAN application packages to use

        • Fuota (integer) --

          The Fport value.

        • Multicast (integer) --

          The Fport value.

        • ClockSync (integer) --

          The Fport value.

    • Sidewalk (dict) --

      Sidewalk device object.

      • AmazonId (string) --

        The Sidewalk Amazon ID.

      • SidewalkId (string) --

        The sidewalk device identification.

      • SidewalkManufacturingSn (string) --

        The Sidewalk manufacturing series number.

      • DeviceCertificates (list) --

        The sidewalk device certificates for Ed25519 and P256r1.

        • (dict) --

          List of sidewalk certificates.

          • SigningAlg (string) --

            The certificate chain algorithm provided by sidewalk.

          • Value (string) --

            The value of the chosen sidewalk certificate.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_device_statistics(**kwargs)

Gets operating information about a wireless device.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_device_statistics(
    WirelessDeviceId='string'
)
Parameters
WirelessDeviceId (string) --

[REQUIRED]

The ID of the wireless device for which to get the data.

Return type
dict
Returns
Response Syntax
{
    'WirelessDeviceId': 'string',
    'LastUplinkReceivedAt': 'string',
    'LoRaWAN': {
        'DevEui': 'string',
        'FPort': 123,
        'DataRate': 123,
        'Frequency': 123,
        'Timestamp': 'string',
        'Gateways': [
            {
                'GatewayEui': 'string',
                'Snr': 123.0,
                'Rssi': 123.0
            },
        ]
    },
    'Sidewalk': {
        'Rssi': 123,
        'BatteryLevel': 'normal'|'low'|'critical',
        'Event': 'discovered'|'lost'|'ack'|'nack'|'passthrough',
        'DeviceState': 'Provisioned'|'RegisteredNotSeen'|'RegisteredReachable'|'RegisteredUnreachable'
    }
}

Response Structure

  • (dict) --
    • WirelessDeviceId (string) --

      The ID of the wireless device.

    • LastUplinkReceivedAt (string) --

      The date and time when the most recent uplink was received.

    • LoRaWAN (dict) --

      Information about the wireless device's operations.

      • DevEui (string) --

        The DevEUI value.

      • FPort (integer) --

        The FPort value.

      • DataRate (integer) --

        The DataRate value.

      • Frequency (integer) --

        The device's channel frequency in Hz.

      • Timestamp (string) --

        The date and time of the metadata.

      • Gateways (list) --

        Information about the gateways accessed by the device.

        • (dict) --

          LoRaWAN gateway metatdata.

          • GatewayEui (string) --

            The gateway's EUI value.

          • Snr (float) --

            The SNR value.

          • Rssi (float) --

            The RSSI value.

    • Sidewalk (dict) --

      MetaData for Sidewalk device.

      • Rssi (integer) --

        The RSSI value.

      • BatteryLevel (string) --

        Sidewalk device battery level.

      • Event (string) --

        Sidewalk device status notification.

      • DeviceState (string) --

        Device state defines the device status of sidewalk device.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_gateway(**kwargs)

Gets information about a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_gateway(
    Identifier='string',
    IdentifierType='GatewayEui'|'WirelessGatewayId'|'ThingName'
)
Parameters
  • Identifier (string) --

    [REQUIRED]

    The identifier of the wireless gateway to get.

  • IdentifierType (string) --

    [REQUIRED]

    The type of identifier used in identifier .

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'Id': 'string',
    'Description': 'string',
    'LoRaWAN': {
        'GatewayEui': 'string',
        'RfRegion': 'string',
        'JoinEuiFilters': [
            [
                'string',
            ],
        ],
        'NetIdFilters': [
            'string',
        ],
        'SubBands': [
            123,
        ]
    },
    'Arn': 'string',
    'ThingName': 'string',
    'ThingArn': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the resource.

    • Id (string) --

      The ID of the wireless gateway.

    • Description (string) --

      The description of the resource.

    • LoRaWAN (dict) --

      Information about the wireless gateway.

      • GatewayEui (string) --

        The gateway's EUI value.

      • RfRegion (string) --

        The frequency band (RFRegion) value.

      • JoinEuiFilters (list) --

        A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

        • (list) --

          A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.

          • (string) --
      • NetIdFilters (list) --

        A list of NetId values that are used by LoRa gateways to filter the uplink frames.

        • (string) --

          LoRaWAN network ID.

      • SubBands (list) --

        A list of integer indicating which sub bands are supported by LoRa gateway.

        • (integer) --

          A subset of supported frequency channels in a certain RFRegion.

    • Arn (string) --

      The Amazon Resource Name of the resource.

    • ThingName (string) --

      The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.

    • ThingArn (string) --

      The ARN of the thing associated with the wireless gateway.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_gateway_certificate(**kwargs)

Gets the ID of the certificate that is currently associated with a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_gateway_certificate(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to get.

Return type
dict
Returns
Response Syntax
{
    'IotCertificateId': 'string',
    'LoRaWANNetworkServerCertificateId': 'string'
}

Response Structure

  • (dict) --
    • IotCertificateId (string) --

      The ID of the certificate associated with the wireless gateway.

    • LoRaWANNetworkServerCertificateId (string) --

      The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_gateway_firmware_information(**kwargs)

Gets the firmware version and other information about a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_gateway_firmware_information(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to get.

Return type
dict
Returns
Response Syntax
{
    'LoRaWAN': {
        'CurrentVersion': {
            'PackageVersion': 'string',
            'Model': 'string',
            'Station': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • LoRaWAN (dict) --

      Information about the wireless gateway's firmware.

      • CurrentVersion (dict) --

        The version of the gateways that should receive the update.

        • PackageVersion (string) --

          The version of the wireless gateway firmware.

        • Model (string) --

          The model number of the wireless gateway.

        • Station (string) --

          The basic station version of the wireless gateway.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_gateway_statistics(**kwargs)

Gets operating information about a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_gateway_statistics(
    WirelessGatewayId='string'
)
Parameters
WirelessGatewayId (string) --

[REQUIRED]

The ID of the wireless gateway for which to get the data.

Return type
dict
Returns
Response Syntax
{
    'WirelessGatewayId': 'string',
    'LastUplinkReceivedAt': 'string',
    'ConnectionStatus': 'Connected'|'Disconnected'
}

Response Structure

  • (dict) --
    • WirelessGatewayId (string) --

      The ID of the wireless gateway.

    • LastUplinkReceivedAt (string) --

      The date and time when the most recent uplink was received.

    • ConnectionStatus (string) --

      The connection status of the wireless gateway.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_gateway_task(**kwargs)

Gets information about a wireless gateway task.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_gateway_task(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to get.

Return type
dict
Returns
Response Syntax
{
    'WirelessGatewayId': 'string',
    'WirelessGatewayTaskDefinitionId': 'string',
    'LastUplinkReceivedAt': 'string',
    'TaskCreatedAt': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'FIRST_RETRY'|'SECOND_RETRY'|'COMPLETED'|'FAILED'
}

Response Structure

  • (dict) --
    • WirelessGatewayId (string) --

      The ID of the wireless gateway.

    • WirelessGatewayTaskDefinitionId (string) --

      The ID of the WirelessGatewayTask.

    • LastUplinkReceivedAt (string) --

      The date and time when the most recent uplink was received.

    • TaskCreatedAt (string) --

      The date and time when the task was created.

    • Status (string) --

      The status of the request.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
get_wireless_gateway_task_definition(**kwargs)

Gets information about a wireless gateway task definition.

See also: AWS API Documentation

Request Syntax

response = client.get_wireless_gateway_task_definition(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the resource to get.

Return type
dict
Returns
Response Syntax
{
    'AutoCreateTasks': True|False,
    'Name': 'string',
    'Update': {
        'UpdateDataSource': 'string',
        'UpdateDataRole': 'string',
        'LoRaWAN': {
            'UpdateSignature': 'string',
            'SigKeyCrc': 123,
            'CurrentVersion': {
                'PackageVersion': 'string',
                'Model': 'string',
                'Station': 'string'
            },
            'UpdateVersion': {
                'PackageVersion': 'string',
                'Model': 'string',
                'Station': 'string'
            }
        }
    },
    'Arn': 'string'
}

Response Structure

  • (dict) --
    • AutoCreateTasks (boolean) --

      Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false , the task must me created by calling CreateWirelessGatewayTask .

    • Name (string) --

      The name of the resource.

    • Update (dict) --

      Information about the gateways to update.

      • UpdateDataSource (string) --

        The link to the S3 bucket.

      • UpdateDataRole (string) --

        The IAM role used to read data from the S3 bucket.

      • LoRaWAN (dict) --

        The properties that relate to the LoRaWAN wireless gateway.

        • UpdateSignature (string) --

          The signature used to verify the update firmware.

        • SigKeyCrc (integer) --

          The CRC of the signature private key to check.

        • CurrentVersion (dict) --

          The version of the gateways that should receive the update.

          • PackageVersion (string) --

            The version of the wireless gateway firmware.

          • Model (string) --

            The model number of the wireless gateway.

          • Station (string) --

            The basic station version of the wireless gateway.

        • UpdateVersion (dict) --

          The firmware version to update the gateway to.

          • PackageVersion (string) --

            The version of the wireless gateway firmware.

          • Model (string) --

            The model number of the wireless gateway.

          • Station (string) --

            The basic station version of the wireless gateway.

    • Arn (string) --

      The Amazon Resource Name of the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_destinations(**kwargs)

Lists the destinations registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_destinations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'DestinationList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ExpressionType': 'RuleName'|'MqttTopic',
            'Expression': 'string',
            'Description': 'string',
            'RoleArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • DestinationList (list) --

      The list of destinations.

      • (dict) --

        Describes a destination.

        • Arn (string) --

          The Amazon Resource Name of the resource.

        • Name (string) --

          The name of the resource.

        • ExpressionType (string) --

          The type of value in Expression .

        • Expression (string) --

          The rule name or topic rule to send messages to.

        • Description (string) --

          The description of the resource.

        • RoleArn (string) --

          The ARN of the IAM Role that authorizes the destination.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_device_profiles(**kwargs)

Lists the device profiles registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_device_profiles(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'DeviceProfileList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Id': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • DeviceProfileList (list) --

      The list of device profiles.

      • (dict) --

        Describes a device profile.

        • Arn (string) --

          The Amazon Resource Name of the resource.

        • Name (string) --

          The name of the resource.

        • Id (string) --

          The ID of the device profile.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_event_configurations(**kwargs)

List event configurations where at least one event topic has been enabled.

See also: AWS API Documentation

Request Syntax

response = client.list_event_configurations(
    ResourceType='SidewalkAccount'|'WirelessDevice'|'WirelessGateway',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ResourceType (string) --

    [REQUIRED]

    Resource type to filter event configurations.

  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'EventConfigurationsList': [
        {
            'Identifier': 'string',
            'IdentifierType': 'PartnerAccountId'|'DevEui'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
            'PartnerType': 'Sidewalk',
            'Events': {
                'DeviceRegistrationState': {
                    'Sidewalk': {
                        'AmazonIdEventTopic': 'Enabled'|'Disabled'
                    },
                    'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
                },
                'Proximity': {
                    'Sidewalk': {
                        'AmazonIdEventTopic': 'Enabled'|'Disabled'
                    },
                    'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
                },
                'Join': {
                    'LoRaWAN': {
                        'DevEuiEventTopic': 'Enabled'|'Disabled'
                    },
                    'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
                },
                'ConnectionStatus': {
                    'LoRaWAN': {
                        'GatewayEuiEventTopic': 'Enabled'|'Disabled'
                    },
                    'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
                }
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • EventConfigurationsList (list) --

      Event configurations of all events for a single resource.

      • (dict) --

        Event configuration object for a single resource.

        • Identifier (string) --

          Resource identifier opted in for event messaging.

        • IdentifierType (string) --

          Identifier type of the particular resource identifier for event configuration.

        • PartnerType (string) --

          Partner type of the resource if the identifier type is PartnerAccountId.

        • Events (dict) --

          Object of all event configurations and the status of the event topics.

          • DeviceRegistrationState (dict) --

            Device registration state event configuration for an event configuration item.

            • Sidewalk (dict) --

              Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

              • AmazonIdEventTopic (string) --

                Enum to denote whether amazon id event topic is enabled or disabled.

            • WirelessDeviceIdEventTopic (string) --

              Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

          • Proximity (dict) --

            Proximity event configuration for an event configuration item.

            • Sidewalk (dict) --

              Proximity event configuration object for enabling or disabling Sidewalk related event topics.

              • AmazonIdEventTopic (string) --

                Enum to denote whether amazon id event topic is enabled or disabled.

            • WirelessDeviceIdEventTopic (string) --

              Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

          • Join (dict) --

            Join event configuration for an event configuration item.

            • LoRaWAN (dict) --

              Join event configuration object for enabling or disabling LoRaWAN related event topics.

              • DevEuiEventTopic (string) --

                Enum to denote whether the dev eui join event topic is enabled or disabled.

            • WirelessDeviceIdEventTopic (string) --

              Enum to denote whether the wireless device id join event topic is enabled or disabled.

          • ConnectionStatus (dict) --

            Connection status event configuration for an event configuration item.

            • LoRaWAN (dict) --

              Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

              • GatewayEuiEventTopic (string) --

                Enum to denote whether the gateway eui connection status event topic is enabled or disabled.

            • WirelessGatewayIdEventTopic (string) --

              Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
list_fuota_tasks(**kwargs)

Lists the FUOTA tasks registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_fuota_tasks(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'FuotaTaskList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • FuotaTaskList (list) --

      Lists the FUOTA tasks registered to your AWS account.

      • (dict) --

        A FUOTA task.

        • Id (string) --

          The ID of a FUOTA task.

        • Arn (string) --

          The arn of a FUOTA task.

        • Name (string) --

          The name of a FUOTA task.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_multicast_groups(**kwargs)

Lists the multicast groups registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_multicast_groups(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MulticastGroupList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MulticastGroupList (list) --

      List of multicast groups.

      • (dict) --

        A multicast group.

        • Id (string) --

          The ID of the multicast group.

        • Arn (string) --

          The arn of the multicast group.

        • Name (string) --

          The name of the multicast group.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_multicast_groups_by_fuota_task(**kwargs)

List all multicast groups associated with a fuota task.

See also: AWS API Documentation

Request Syntax

response = client.list_multicast_groups_by_fuota_task(
    Id='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'MulticastGroupList': [
        {
            'Id': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MulticastGroupList (list) --

      List of multicast groups associated with a FUOTA task.

      • (dict) --

        A multicast group that is associated with a FUOTA task.

        • Id (string) --

          The ID of the multicast group.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
list_network_analyzer_configurations(**kwargs)

Lists the network analyzer configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_network_analyzer_configurations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'NetworkAnalyzerConfigurationList': [
        {
            'Arn': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • NetworkAnalyzerConfigurationList (list) --

      The list of network analyzer configurations.

      • (dict) --

        Network analyzer configurations.

        • Arn (string) --

          The Amazon Resource Name of the new resource.

        • Name (string) --

          Name of the network analyzer configuration.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_partner_accounts(**kwargs)

Lists the partner accounts associated with your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_partner_accounts(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Sidewalk': [
        {
            'AmazonId': 'string',
            'Fingerprint': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • Sidewalk (list) --

      The Sidewalk account credentials.

      • (dict) --

        Information about a Sidewalk account.

        • AmazonId (string) --

          The Sidewalk Amazon ID.

        • Fingerprint (string) --

          The fingerprint of the Sidewalk application server private key.

        • Arn (string) --

          The Amazon Resource Name of the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_queued_messages(**kwargs)

List queued messages in the downlink queue.

See also: AWS API Documentation

Request Syntax

response = client.list_queued_messages(
    Id='string',
    NextToken='string',
    MaxResults=123,
    WirelessDeviceType='Sidewalk'|'LoRaWAN'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a given wireless device which the downlink message packets are being sent.

  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • WirelessDeviceType (string) -- The wireless device type, whic can be either Sidewalk or LoRaWAN.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'DownlinkQueueMessagesList': [
        {
            'MessageId': 'string',
            'TransmitMode': 123,
            'ReceivedAt': 'string',
            'LoRaWAN': {
                'FPort': 123
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • DownlinkQueueMessagesList (list) --

      The messages in the downlink queue.

      • (dict) --

        The message in the downlink queue.

        • MessageId (string) --

          The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.

        • TransmitMode (integer) --

          The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

        • ReceivedAt (string) --

          The time at which Iot Wireless received the downlink message.

        • LoRaWAN (dict) --

          LoRaWAN router info.

          • FPort (integer) --

            The Fport value.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.AccessDeniedException
list_service_profiles(**kwargs)

Lists the service profiles registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_service_profiles(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'ServiceProfileList': [
        {
            'Arn': 'string',
            'Name': 'string',
            'Id': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • ServiceProfileList (list) --

      The list of service profiles.

      • (dict) --

        Information about a service profile.

        • Arn (string) --

          The Amazon Resource Name of the resource.

        • Name (string) --

          The name of the resource.

        • Id (string) --

          The ID of the service profile.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_tags_for_resource(**kwargs)

Lists the tags (metadata) you have assigned to the resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The ARN of the resource for which you want to list tags.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      The tags to attach to the specified resource. 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) --

          The tag's key value.

        • Value (string) --

          The tag's value.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_wireless_devices(**kwargs)

Lists the wireless devices registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_wireless_devices(
    MaxResults=123,
    NextToken='string',
    DestinationName='string',
    DeviceProfileId='string',
    ServiceProfileId='string',
    WirelessDeviceType='Sidewalk'|'LoRaWAN',
    FuotaTaskId='string',
    MulticastGroupId='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • DestinationName (string) -- A filter to list only the wireless devices that use this destination.
  • DeviceProfileId (string) -- A filter to list only the wireless devices that use this device profile.
  • ServiceProfileId (string) -- A filter to list only the wireless devices that use this service profile.
  • WirelessDeviceType (string) -- A filter to list only the wireless devices that use this wireless device type.
  • FuotaTaskId (string) -- The ID of a FUOTA task.
  • MulticastGroupId (string) -- The ID of the multicast group.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'WirelessDeviceList': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Type': 'Sidewalk'|'LoRaWAN',
            'Name': 'string',
            'DestinationName': 'string',
            'LastUplinkReceivedAt': 'string',
            'LoRaWAN': {
                'DevEui': 'string'
            },
            'Sidewalk': {
                'AmazonId': 'string',
                'SidewalkId': 'string',
                'SidewalkManufacturingSn': 'string',
                'DeviceCertificates': [
                    {
                        'SigningAlg': 'Ed25519'|'P256r1',
                        'Value': 'string'
                    },
                ]
            },
            'FuotaDeviceStatus': 'Initial'|'Package_Not_Supported'|'FragAlgo_unsupported'|'Not_enough_memory'|'FragIndex_unsupported'|'Wrong_descriptor'|'SessionCnt_replay'|'MissingFrag'|'MemoryError'|'MICError'|'Successful',
            'MulticastDeviceStatus': 'string',
            'McGroupId': 123
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • WirelessDeviceList (list) --

      The ID of the wireless device.

      • (dict) --

        Information about a wireless device's operation.

        • Arn (string) --

          The Amazon Resource Name of the resource.

        • Id (string) --

          The ID of the wireless device reporting the data.

        • Type (string) --

          The wireless device type.

        • Name (string) --

          The name of the resource.

        • DestinationName (string) --

          The name of the destination to which the device is assigned.

        • LastUplinkReceivedAt (string) --

          The date and time when the most recent uplink was received.

        • LoRaWAN (dict) --

          LoRaWAN device info.

          • DevEui (string) --

            The DevEUI value.

        • Sidewalk (dict) --

          The Sidewalk account credentials.

          • AmazonId (string) --

            The Sidewalk Amazon ID.

          • SidewalkId (string) --

            The sidewalk device identification.

          • SidewalkManufacturingSn (string) --

            The Sidewalk manufacturing series number.

          • DeviceCertificates (list) --

            The sidewalk device certificates for Ed25519 and P256r1.

            • (dict) --

              List of sidewalk certificates.

              • SigningAlg (string) --

                The certificate chain algorithm provided by sidewalk.

              • Value (string) --

                The value of the chosen sidewalk certificate.

        • FuotaDeviceStatus (string) --

          The status of a wireless device in a FUOTA task.

        • MulticastDeviceStatus (string) --

          The status of the wireless device in the multicast group.

        • McGroupId (integer) --

          Id of the multicast group.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.AccessDeniedException
list_wireless_gateway_task_definitions(**kwargs)

List the wireless gateway tasks definitions registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_wireless_gateway_task_definitions(
    MaxResults=123,
    NextToken='string',
    TaskDefinitionType='UPDATE'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in this operation.
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • TaskDefinitionType (string) -- A filter to list only the wireless gateway task definitions that use this task definition type.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'TaskDefinitions': [
        {
            'Id': 'string',
            'LoRaWAN': {
                'CurrentVersion': {
                    'PackageVersion': 'string',
                    'Model': 'string',
                    'Station': 'string'
                },
                'UpdateVersion': {
                    'PackageVersion': 'string',
                    'Model': 'string',
                    'Station': 'string'
                }
            },
            'Arn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • TaskDefinitions (list) --

      The list of task definitions.

      • (dict) --

        UpdateWirelessGatewayTaskEntry object.

        • Id (string) --

          The ID of the new wireless gateway task entry.

        • LoRaWAN (dict) --

          The properties that relate to the LoRaWAN wireless gateway.

          • CurrentVersion (dict) --

            The version of the gateways that should receive the update.

            • PackageVersion (string) --

              The version of the wireless gateway firmware.

            • Model (string) --

              The model number of the wireless gateway.

            • Station (string) --

              The basic station version of the wireless gateway.

          • UpdateVersion (dict) --

            The firmware version to update the gateway to.

            • PackageVersion (string) --

              The version of the wireless gateway firmware.

            • Model (string) --

              The model number of the wireless gateway.

            • Station (string) --

              The basic station version of the wireless gateway.

        • Arn (string) --

          The Amazon Resource Name of the resource.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
list_wireless_gateways(**kwargs)

Lists the wireless gateways registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_wireless_gateways(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
  • MaxResults (integer) -- The maximum number of results to return in this operation.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'WirelessGatewayList': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'LoRaWAN': {
                'GatewayEui': 'string',
                'RfRegion': 'string',
                'JoinEuiFilters': [
                    [
                        'string',
                    ],
                ],
                'NetIdFilters': [
                    'string',
                ],
                'SubBands': [
                    123,
                ]
            },
            'LastUplinkReceivedAt': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to get the next set of results, or null if there are no additional results.

    • WirelessGatewayList (list) --

      The ID of the wireless gateway.

      • (dict) --

        Information about a wireless gateway's operation.

        • Arn (string) --

          The Amazon Resource Name of the resource.

        • Id (string) --

          The ID of the wireless gateway reporting the data.

        • Name (string) --

          The name of the resource.

        • Description (string) --

          The description of the resource.

        • LoRaWAN (dict) --

          LoRaWAN gateway info.

          • GatewayEui (string) --

            The gateway's EUI value.

          • RfRegion (string) --

            The frequency band (RFRegion) value.

          • JoinEuiFilters (list) --

            A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

            • (list) --

              A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.

              • (string) --
          • NetIdFilters (list) --

            A list of NetId values that are used by LoRa gateways to filter the uplink frames.

            • (string) --

              LoRaWAN network ID.

          • SubBands (list) --

            A list of integer indicating which sub bands are supported by LoRa gateway.

            • (integer) --

              A subset of supported frequency channels in a certain RFRegion.

        • LastUplinkReceivedAt (string) --

          The date and time when the most recent uplink was received.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.AccessDeniedException
put_resource_log_level(**kwargs)

Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.

See also: AWS API Documentation

Request Syntax

response = client.put_resource_log_level(
    ResourceIdentifier='string',
    ResourceType='string',
    LogLevel='INFO'|'ERROR'|'DISABLED'
)
Parameters
  • ResourceIdentifier (string) --

    [REQUIRED]

    The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

  • ResourceType (string) --

    [REQUIRED]

    The type of the resource, which can be WirelessDevice or WirelessGateway .

  • LogLevel (string) --

    [REQUIRED]

    The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ValidationException
reset_all_resource_log_levels()

Removes the log-level overrides for all resources; both wireless devices and wireless gateways.

See also: AWS API Documentation

Request Syntax

response = client.reset_all_resource_log_levels()
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ValidationException
reset_resource_log_level(**kwargs)

Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.reset_resource_log_level(
    ResourceIdentifier='string',
    ResourceType='string'
)
Parameters
  • ResourceIdentifier (string) --

    [REQUIRED]

    The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

  • ResourceType (string) --

    [REQUIRED]

    The type of the resource, which can be WirelessDevice or WirelessGateway .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ValidationException
send_data_to_multicast_group(**kwargs)

Sends the specified data to a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.send_data_to_multicast_group(
    Id='string',
    PayloadData='string',
    WirelessMetadata={
        'LoRaWAN': {
            'FPort': 123
        }
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • PayloadData (string) --

    [REQUIRED]

    The binary to be sent to the end device, encoded in base64.

  • WirelessMetadata (dict) --

    [REQUIRED]

    Wireless metadata that is to be sent to multicast group.

    • LoRaWAN (dict) --

      The metadata information of the LoRaWAN multicast group.

      • FPort (integer) --

        The Fport value.

Return type

dict

Returns

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • MessageId (string) --

      ID of a multicast group message.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
send_data_to_wireless_device(**kwargs)

Sends a decrypted application data frame to a device.

See also: AWS API Documentation

Request Syntax

response = client.send_data_to_wireless_device(
    Id='string',
    TransmitMode=123,
    PayloadData='string',
    WirelessMetadata={
        'LoRaWAN': {
            'FPort': 123
        },
        'Sidewalk': {
            'Seq': 123,
            'MessageType': 'CUSTOM_COMMAND_ID_NOTIFY'|'CUSTOM_COMMAND_ID_GET'|'CUSTOM_COMMAND_ID_SET'|'CUSTOM_COMMAND_ID_RESP'
        }
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the wireless device to receive the data.

  • TransmitMode (integer) --

    [REQUIRED]

    The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

  • PayloadData (string) --

    [REQUIRED]

    The binary to be sent to the end device, encoded in base64.

  • WirelessMetadata (dict) --

    Metadata about the message request.

    • LoRaWAN (dict) --

      LoRaWAN device info.

      • FPort (integer) --

        The Fport value.

    • Sidewalk (dict) --

      The Sidewalk account credentials.

      • Seq (integer) --

        The sequence number.

      • MessageType (string) --

        Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY .

Return type

dict

Returns

Response Syntax

{
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • MessageId (string) --

      The ID of the message sent to the wireless device.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
start_bulk_associate_wireless_device_with_multicast_group(**kwargs)

Starts a bulk association of all qualifying wireless devices with a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.start_bulk_associate_wireless_device_with_multicast_group(
    Id='string',
    QueryString='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • QueryString (string) -- Query string used to search for wireless devices as part of the bulk associate and disassociate process.
  • Tags (list) --

    The tag to attach to the specified resource. 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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
start_bulk_disassociate_wireless_device_from_multicast_group(**kwargs)

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.start_bulk_disassociate_wireless_device_from_multicast_group(
    Id='string',
    QueryString='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • QueryString (string) -- Query string used to search for wireless devices as part of the bulk associate and disassociate process.
  • Tags (list) --

    The tag to attach to the specified resource. 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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
start_fuota_task(**kwargs)

Starts a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.start_fuota_task(
    Id='string',
    LoRaWAN={
        'StartTime': datetime(2015, 1, 1)
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • LoRaWAN (dict) --

    The LoRaWAN information used to start a FUOTA task.

    • StartTime (datetime) --

      Start time of a FUOTA task.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
start_multicast_group_session(**kwargs)

Starts a multicast group session.

See also: AWS API Documentation

Request Syntax

response = client.start_multicast_group_session(
    Id='string',
    LoRaWAN={
        'DlDr': 123,
        'DlFreq': 123,
        'SessionStartTime': datetime(2015, 1, 1),
        'SessionTimeout': 123
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • LoRaWAN (dict) --

    [REQUIRED]

    The LoRaWAN information used with the multicast session.

    • DlDr (integer) --

      Downlink data rate.

    • DlFreq (integer) --

      Downlink frequency.

    • SessionStartTime (datetime) --

      Timestamp of when the multicast group session is to start.

    • SessionTimeout (integer) --

      How long before a multicast group session is to timeout.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
tag_resource(**kwargs)

Adds a tag to a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource to add tags to.

  • Tags (list) --

    [REQUIRED]

    Adds to or modifies the tags of the given resource. 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.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.TooManyTagsException
test_wireless_device(**kwargs)

Simulates a provisioned device by sending an uplink data payload of Hello .

See also: AWS API Documentation

Request Syntax

response = client.test_wireless_device(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The ID of the wireless device to test.

Return type
dict
Returns
Response Syntax
{
    'Result': 'string'
}

Response Structure

  • (dict) --
    • Result (string) --

      The result returned by the test.

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
untag_resource(**kwargs)

Removes one or more tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The ARN of the resource to remove tags from.

  • TagKeys (list) --

    [REQUIRED]

    A list of the keys of the tags to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_destination(**kwargs)

Updates properties of a destination.

See also: AWS API Documentation

Request Syntax

response = client.update_destination(
    Name='string',
    ExpressionType='RuleName'|'MqttTopic',
    Expression='string',
    Description='string',
    RoleArn='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The new name of the resource.

  • ExpressionType (string) -- The type of value in Expression .
  • Expression (string) -- The new rule name or topic rule to send messages to.
  • Description (string) -- A new description of the resource.
  • RoleArn (string) -- The ARN of the IAM Role that authorizes the destination.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_event_configuration_by_resource_types(**kwargs)

Update the event configuration by resource types.

See also: AWS API Documentation

Request Syntax

response = client.update_event_configuration_by_resource_types(
    DeviceRegistrationState={
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    Proximity={
        'Sidewalk': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    Join={
        'LoRaWAN': {
            'WirelessDeviceEventTopic': 'Enabled'|'Disabled'
        }
    },
    ConnectionStatus={
        'LoRaWAN': {
            'WirelessGatewayEventTopic': 'Enabled'|'Disabled'
        }
    }
)
Parameters
  • DeviceRegistrationState (dict) --

    Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.

    • Sidewalk (dict) --

      Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.

      • WirelessDeviceEventTopic (string) --

        Enum to denote whether the wireless device join event topic is enabled or disabled.

  • Proximity (dict) --

    Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

    • Sidewalk (dict) --

      Proximity resource type event configuration object for enabling and disabling wireless device topic.

      • WirelessDeviceEventTopic (string) --

        Enum to denote whether the wireless device join event topic is enabled or disabled.

  • Join (dict) --

    Join resource type event configuration object for enabling and disabling wireless device topic.

    • LoRaWAN (dict) --

      Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.

      • WirelessDeviceEventTopic (string) --

        Enum to denote whether the wireless device join event topic is enabled or disabled.

  • ConnectionStatus (dict) --

    Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

    • LoRaWAN (dict) --

      Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.

      • WirelessGatewayEventTopic (string) --

        Enum to denote whether the wireless gateway connection status event topic is enabled or disabled.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.InternalServerException
update_fuota_task(**kwargs)

Updates properties of a FUOTA task.

See also: AWS API Documentation

Request Syntax

response = client.update_fuota_task(
    Id='string',
    Name='string',
    Description='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'
    },
    FirmwareUpdateImage='string',
    FirmwareUpdateRole='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of a FUOTA task.

  • Name (string) -- The name of a FUOTA task.
  • Description (string) -- The description of the new resource.
  • LoRaWAN (dict) --

    The LoRaWAN information used with a FUOTA task.

    • RfRegion (string) --

      Supported RfRegions

  • FirmwareUpdateImage (string) -- The S3 URI points to a firmware update image that is to be used with a FUOTA task.
  • FirmwareUpdateRole (string) -- The firmware update role that is to be used with a FUOTA task.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_log_levels_by_resource_types(**kwargs)

Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.

See also: AWS API Documentation

Request Syntax

response = client.update_log_levels_by_resource_types(
    DefaultLogLevel='INFO'|'ERROR'|'DISABLED',
    WirelessDeviceLogOptions=[
        {
            'Type': 'Sidewalk'|'LoRaWAN',
            'LogLevel': 'INFO'|'ERROR'|'DISABLED',
            'Events': [
                {
                    'Event': 'Join'|'Rejoin'|'Uplink_Data'|'Downlink_Data'|'Registration',
                    'LogLevel': 'INFO'|'ERROR'|'DISABLED'
                },
            ]
        },
    ],
    WirelessGatewayLogOptions=[
        {
            'Type': 'LoRaWAN',
            'LogLevel': 'INFO'|'ERROR'|'DISABLED',
            'Events': [
                {
                    'Event': 'CUPS_Request'|'Certificate',
                    'LogLevel': 'INFO'|'ERROR'|'DISABLED'
                },
            ]
        },
    ]
)
Parameters
  • DefaultLogLevel (string) -- The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.
  • WirelessDeviceLogOptions (list) --

    The list of wireless device log options.

    • (dict) --

      The log options for wireless devices and can be used to set log levels for a specific type of wireless device.

      • Type (string) -- [REQUIRED]

        The wireless device type.

      • LogLevel (string) -- [REQUIRED]

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

      • Events (list) --

        The list of wireless device event log options.

        • (dict) --

          The log options for a wireless device event and can be used to set log levels for a specific wireless device event.

          For a LoRaWAN device, possible events for a log messsage are: Join , Rejoin , Downlink_Data , and Uplink_Data . For a Sidewalk device, possible events for a log message are Registration , Downlink_Data , and Uplink_Data .

          • Event (string) -- [REQUIRED]

            The event for a log message, if the log message is tied to a wireless device.

          • LogLevel (string) -- [REQUIRED]

            The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

  • WirelessGatewayLogOptions (list) --

    The list of wireless gateway log options.

    • (dict) --

      The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.

      • Type (string) -- [REQUIRED]

        The wireless gateway type.

      • LogLevel (string) -- [REQUIRED]

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

      • Events (list) --

        The list of wireless gateway event log options.

        • (dict) --

          The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.

          For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate .

          • Event (string) -- [REQUIRED]

            The event for a log message, if the log message is tied to a wireless gateway.

          • LogLevel (string) -- [REQUIRED]

            The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ValidationException
update_multicast_group(**kwargs)

Updates properties of a multicast group session.

See also: AWS API Documentation

Request Syntax

response = client.update_multicast_group(
    Id='string',
    Name='string',
    Description='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1',
        'DlClass': 'ClassB'|'ClassC'
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the multicast group.

  • Name (string) -- The name of the multicast group.
  • Description (string) -- The description of the new resource.
  • LoRaWAN (dict) --

    The LoRaWAN information that is to be used with the multicast group.

    • RfRegion (string) --

      Supported RfRegions

    • DlClass (string) --

      DlClass for LoRaWAM, valid values are ClassB and ClassC.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_network_analyzer_configuration(**kwargs)

Update network analyzer configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_network_analyzer_configuration(
    ConfigurationName='string',
    TraceContent={
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED'
    },
    WirelessDevicesToAdd=[
        'string',
    ],
    WirelessDevicesToRemove=[
        'string',
    ],
    WirelessGatewaysToAdd=[
        'string',
    ],
    WirelessGatewaysToRemove=[
        'string',
    ],
    Description='string'
)
Parameters
  • ConfigurationName (string) --

    [REQUIRED]

    Name of the network analyzer configuration.

  • TraceContent (dict) --

    Trace content for your wireless gateway and wireless device resources.

    • WirelessDeviceFrameInfo (string) --

      FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

    • LogLevel (string) --

      The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

  • WirelessDevicesToAdd (list) --

    Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

    • (string) --

      The ID of the wireless device.

  • WirelessDevicesToRemove (list) --

    Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

    • (string) --

      The ID of the wireless device.

  • WirelessGatewaysToAdd (list) --

    Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

    • (string) --
  • WirelessGatewaysToRemove (list) --

    Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

    • (string) --
  • Description (string) -- The description of the new resource.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_partner_account(**kwargs)

Updates properties of a partner account.

See also: AWS API Documentation

Request Syntax

response = client.update_partner_account(
    Sidewalk={
        'AppServerPrivateKey': 'string'
    },
    PartnerAccountId='string',
    PartnerType='Sidewalk'
)
Parameters
  • Sidewalk (dict) --

    [REQUIRED]

    The Sidewalk account credentials.

    • AppServerPrivateKey (string) --

      The new Sidewalk application server private key.

  • PartnerAccountId (string) --

    [REQUIRED]

    The ID of the partner account to update.

  • PartnerType (string) --

    [REQUIRED]

    The partner type.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_resource_event_configuration(**kwargs)

Update the event configuration for a particular resource identifier.

See also: AWS API Documentation

Request Syntax

response = client.update_resource_event_configuration(
    Identifier='string',
    IdentifierType='PartnerAccountId'|'DevEui'|'GatewayEui'|'WirelessDeviceId'|'WirelessGatewayId',
    PartnerType='Sidewalk',
    DeviceRegistrationState={
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    Proximity={
        'Sidewalk': {
            'AmazonIdEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    Join={
        'LoRaWAN': {
            'DevEuiEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessDeviceIdEventTopic': 'Enabled'|'Disabled'
    },
    ConnectionStatus={
        'LoRaWAN': {
            'GatewayEuiEventTopic': 'Enabled'|'Disabled'
        },
        'WirelessGatewayIdEventTopic': 'Enabled'|'Disabled'
    }
)
Parameters
  • Identifier (string) --

    [REQUIRED]

    Resource identifier to opt in for event messaging.

  • IdentifierType (string) --

    [REQUIRED]

    Identifier type of the particular resource identifier for event configuration.

  • PartnerType (string) -- Partner type of the resource if the identifier type is PartnerAccountId
  • DeviceRegistrationState (dict) --

    Event configuration for the device registration state event

    • Sidewalk (dict) --

      Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

      • AmazonIdEventTopic (string) --

        Enum to denote whether amazon id event topic is enabled or disabled.

    • WirelessDeviceIdEventTopic (string) --

      Enum to denote whether the wireless device id device registration state event topic is enabled or disabled.

  • Proximity (dict) --

    Event configuration for the Proximity event

    • Sidewalk (dict) --

      Proximity event configuration object for enabling or disabling Sidewalk related event topics.

      • AmazonIdEventTopic (string) --

        Enum to denote whether amazon id event topic is enabled or disabled.

    • WirelessDeviceIdEventTopic (string) --

      Enum to denote whether the wireless device id proximity event topic is enabled or disabled.

  • Join (dict) --

    Event configuration for the join event

    • LoRaWAN (dict) --

      Join event configuration object for enabling or disabling LoRaWAN related event topics.

      • DevEuiEventTopic (string) --

        Enum to denote whether the dev eui join event topic is enabled or disabled.

    • WirelessDeviceIdEventTopic (string) --

      Enum to denote whether the wireless device id join event topic is enabled or disabled.

  • ConnectionStatus (dict) --

    Event configuration for the connection status event

    • LoRaWAN (dict) --

      Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

      • GatewayEuiEventTopic (string) --

        Enum to denote whether the gateway eui connection status event topic is enabled or disabled.

    • WirelessGatewayIdEventTopic (string) --

      Enum to denote whether the wireless gateway id connection status event topic is enabled or disabled .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.ConflictException
  • IoTWireless.Client.exceptions.ThrottlingException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.InternalServerException
update_wireless_device(**kwargs)

Updates properties of a wireless device.

See also: AWS API Documentation

Request Syntax

response = client.update_wireless_device(
    Id='string',
    DestinationName='string',
    Name='string',
    Description='string',
    LoRaWAN={
        'DeviceProfileId': 'string',
        'ServiceProfileId': 'string',
        'AbpV1_1': {
            'FCntStart': 123
        },
        'AbpV1_0_x': {
            'FCntStart': 123
        }
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the resource to update.

  • DestinationName (string) -- The name of the new destination for the device.
  • Name (string) -- The new name of the resource.
  • Description (string) -- A new description of the resource.
  • LoRaWAN (dict) --

    The updated wireless device's configuration.

    • DeviceProfileId (string) --

      The ID of the device profile for the wireless device.

    • ServiceProfileId (string) --

      The ID of the service profile.

    • AbpV1_1 (dict) --

      ABP device object for update APIs for v1.1

      • FCntStart (integer) --

        The FCnt init value.

    • AbpV1_0_x (dict) --

      ABP device object for update APIs for v1.0.x

      • FCntStart (integer) --

        The FCnt init value.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • IoTWireless.Client.exceptions.ValidationException
  • IoTWireless.Client.exceptions.ResourceNotFoundException
  • IoTWireless.Client.exceptions.AccessDeniedException
  • IoTWireless.Client.exceptions.InternalServerException
  • IoTWireless.Client.exceptions.ThrottlingException
update_wireless_gateway(**kwargs)

Updates properties of a wireless gateway.

See also: AWS API Documentation

Request Syntax

response = client.update_wireless_gateway(
    Id='string',
    Name='string',
    Description='string',
    JoinEuiFilters=[
        [
            'string',
        ],
    ],
    NetIdFilters=[
        'string',
    ]
)
Parameters
  • Id (string) --

    [REQUIRED]

    The ID of the resource to update.

  • Name (string) -- The new name of the resource.
  • Description (string) -- A new description of the resource.
  • JoinEuiFilters (list) --

    A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

    • (list) --

      A pair of join EUI describing a range [BegEui, EndEui], both ends are inclusive.

      • (string) --
  • NetIdFilters (list) --

    A list of NetId values that are used by LoRa gateways to filter the uplink frames.

    • (string) --

      LoRaWAN network ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

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

Paginators

The available paginators are: