network_analyzer_configurations

Creates, updates, deletes, gets or lists a network_analyzer_configurations resource.

Overview

Name	network_analyzer_configurations
Type	Resource
Id	aws.iotwireless.network_analyzer_configurations

Fields

The following fields are returned by SELECT queries:

get_network_analyzer_configuration

Name	Datatype	Description
arn	string	The Amazon Resource Name of the new resource.
description	string	The description of the new resource.
multicast_groups	array	List of multicast group resources that have been added to the network analyzer configuration.
name	string	Name of the network analyzer configuration. (pattern: <code>[a-zA-Z0-9-_]+</code>)
trace_content	object	Trace content for your wireless devices, gateways, and multicast groups.
wireless_devices	array	List of wireless device resources that have been added to the network analyzer configuration.
wireless_gateways	array	List of wireless gateway resources that have been added to the network analyzer configuration.

list_network_analyzer_configurations

Name	Datatype	Description
network_analyzer_configuration_list	array	The list of network analyzer configurations.
next_token	string	The token to use to get the next set of results, or null if there are no additional results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_analyzer_configuration	select	configuration_name, region		Get network analyzer configuration.
list_network_analyzer_configurations	select	region	maxResults, nextToken	Lists the network analyzer configurations.
create_network_analyzer_configuration	insert	region		Creates a new network analyzer configuration.
update_network_analyzer_configuration	update	configuration_name, region		Update network analyzer configuration.
delete_network_analyzer_configuration	delete	configuration_name, region		Deletes a network analyzer configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configuration_name	string
region	string	AWS region (default: us-east-1)
maxResults	integer
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.

SELECT examples

get_network_analyzer_configuration

Get network analyzer configuration.

SELECT
arn,
description,
multicast_groups,
name,
trace_content,
wireless_devices,
wireless_gateways
FROM aws.iotwireless.network_analyzer_configurations
WHERE configuration_name = '{{ configuration_name }}' -- required
AND region = '{{ region }}' -- required
;

list_network_analyzer_configurations

Lists the network analyzer configurations.

SELECT
network_analyzer_configuration_list,
next_token
FROM aws.iotwireless.network_analyzer_configurations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_network_analyzer_configuration

Creates a new network analyzer configuration.

INSERT INTO aws.iotwireless.network_analyzer_configurations (
Name,
TraceContent,
WirelessDevices,
WirelessGateways,
Description,
Tags,
ClientRequestToken,
MulticastGroups,
region
)
SELECT 
'{{ Name }}',
'{{ TraceContent }}',
'{{ WirelessDevices }}',
'{{ WirelessGateways }}',
'{{ Description }}',
'{{ Tags }}',
'{{ ClientRequestToken }}',
'{{ MulticastGroups }}',
'{{ region }}'
RETURNING
arn,
name
;

Manifest

# Description fields are for documentation purposes
- name: network_analyzer_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_analyzer_configurations resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      Name of the network analyzer configuration.
  - name: TraceContent
    description: |
      Trace content for your wireless devices, gateways, and multicast groups.
    value:
      WirelessDeviceFrameInfo: "{{ WirelessDeviceFrameInfo }}"
      LogLevel: "{{ LogLevel }}"
      MulticastFrameInfo: "{{ MulticastFrameInfo }}"
  - name: WirelessDevices
    value:
      - "{{ WirelessDevices }}"
  - name: WirelessGateways
    value:
      - "{{ WirelessGateways }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the new resource.
  - name: Tags
    description: |
      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      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.
  - name: MulticastGroups
    value:
      - "{{ MulticastGroups }}"

UPDATE examples

update_network_analyzer_configuration

Update network analyzer configuration.

UPDATE aws.iotwireless.network_analyzer_configurations
SET 
TraceContent = '{{ TraceContent }}',
WirelessDevicesToAdd = '{{ WirelessDevicesToAdd }}',
WirelessDevicesToRemove = '{{ WirelessDevicesToRemove }}',
WirelessGatewaysToAdd = '{{ WirelessGatewaysToAdd }}',
WirelessGatewaysToRemove = '{{ WirelessGatewaysToRemove }}',
Description = '{{ Description }}',
MulticastGroupsToAdd = '{{ MulticastGroupsToAdd }}',
MulticastGroupsToRemove = '{{ MulticastGroupsToRemove }}'
WHERE 
configuration_name = '{{ configuration_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_network_analyzer_configuration

Deletes a network analyzer configuration.

DELETE FROM aws.iotwireless.network_analyzer_configurations
WHERE configuration_name = '{{ configuration_name }}' --required
AND region = '{{ region }}' --required
;