IoTWireless / Client / create_network_analyzer_configuration

create_network_analyzer_configuration#

IoTWireless.Client.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',
        'MulticastFrameInfo': 'ENABLED'|'DISABLED'
    },
    WirelessDevices=[
        'string',
    ],
    WirelessGateways=[
        'string',
    ],
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ClientRequestToken='string',
    MulticastGroups=[
        'string',
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    Name of the network analyzer configuration.

  • TraceContent (dict) –

    Trace content for your wireless devices, gateways, and multicast groups.

    • 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 multicast groups and the network server.

  • 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. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    This field is autopopulated if not provided.

  • MulticastGroups (list) –

    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.

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