AWS IoT Wireless

{'MulticastGroups': ['string'],
 'TraceContent': {'MulticastFrameInfo': 'ENABLED | DISABLED'}}

Creates a new network analyzer configuration.

See also: AWS API Documentation

Request Syntax

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

type Name:

string

param Name:

[REQUIRED]

Name of the network analyzer configuration.

type TraceContent:

dict

param TraceContent:

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.

• MulticastFrameInfo (string) --

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

type WirelessDevices:

list

param WirelessDevices:

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.

type WirelessGateways:

list

param WirelessGateways:

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

• (string) --

type Description:

string

param Description:

The description of the new resource.

type Tags:

list

param Tags:

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.

type ClientRequestToken:

string

param ClientRequestToken:

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.

type MulticastGroups:

list

param MulticastGroups:

Multicast Group resources to add to the network analyzer configruation. Provide the MulticastGroupId of the resource to add in the input array.

• (string) --

  The ID of the multicast group.

rtype:

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.

{'MulticastGroups': ['string'],
 'TraceContent': {'MulticastFrameInfo': 'ENABLED | DISABLED'}}

Get network analyzer configuration.

See also: AWS API Documentation

Request Syntax

client.get_network_analyzer_configuration(
    ConfigurationName='string'
)

type ConfigurationName:

string

param ConfigurationName:

[REQUIRED]

Name of the network analyzer configuration.

rtype:

dict

returns:

Response Syntax

{
    'TraceContent': {
        'WirelessDeviceFrameInfo': 'ENABLED'|'DISABLED',
        'LogLevel': 'INFO'|'ERROR'|'DISABLED',
        'MulticastFrameInfo': 'ENABLED'|'DISABLED'
    },
    'WirelessDevices': [
        'string',
    ],
    'WirelessGateways': [
        'string',
    ],
    'Description': 'string',
    'Arn': 'string',
    'Name': 'string',
    'MulticastGroups': [
        '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.

    • MulticastFrameInfo (string) --

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

  • 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.

  • MulticastGroups (list) --

    List of multicast group resources that have been added to the network analyzer configuration.

    • (string) --

      The ID of the multicast group.

{'MulticastGroupsToAdd': ['string'],
 'MulticastGroupsToRemove': ['string'],
 'TraceContent': {'MulticastFrameInfo': 'ENABLED | DISABLED'}}

Update network analyzer configuration.

See also: AWS API Documentation

Request Syntax

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

type ConfigurationName:

string

param ConfigurationName:

[REQUIRED]

Name of the network analyzer configuration.

type TraceContent:

dict

param TraceContent:

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.

• MulticastFrameInfo (string) --

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

type WirelessDevicesToAdd:

list

param WirelessDevicesToAdd:

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.

type WirelessDevicesToRemove:

list

param WirelessDevicesToRemove:

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.

type WirelessGatewaysToAdd:

list

param WirelessGatewaysToAdd:

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

• (string) --

type WirelessGatewaysToRemove:

list

param WirelessGatewaysToRemove:

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

• (string) --

type Description:

string

param Description:

The description of the new resource.

type MulticastGroupsToAdd:

list

param MulticastGroupsToAdd:

Multicast group resources to add to the network analyzer configuration. Provide the MulticastGroupId of the resource to add in the input array.

• (string) --

  The ID of the multicast group.

type MulticastGroupsToRemove:

list

param MulticastGroupsToRemove:

Multicast group resources to remove from the network analyzer configuration. Provide the MulticastGroupId of the resource to remove in the input array.

• (string) --

  The ID of the multicast group.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --