UpdateNetworkAnalyzerConfiguration - AWS IoT Wireless

UpdateNetworkAnalyzerConfiguration

Update network analyzer configuration.

Request Syntax

PATCH /network-analyzer-configurations/ConfigurationName HTTP/1.1 Content-type: application/json { "Description": "string", "MulticastGroupsToAdd": [ "string" ], "MulticastGroupsToRemove": [ "string" ], "TraceContent": { "LogLevel": "string", "MulticastFrameInfo": "string", "WirelessDeviceFrameInfo": "string" }, "WirelessDevicesToAdd": [ "string" ], "WirelessDevicesToRemove": [ "string" ], "WirelessGatewaysToAdd": [ "string" ], "WirelessGatewaysToRemove": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

ConfigurationName

Name of the network analyzer configuration.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [a-zA-Z0-9-_]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

MulticastGroupsToAdd

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Maximum length of 256.

Required: No

MulticastGroupsToRemove

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Maximum length of 256.

Required: No

TraceContent

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

Type: TraceContent object

Required: No

WirelessDevicesToAdd

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 250 items.

Length Constraints: Maximum length of 256.

Required: No

WirelessDevicesToRemove

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 250 items.

Length Constraints: Maximum length of 256.

Required: No

WirelessGatewaysToAdd

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

Type: Array of strings

Length Constraints: Maximum length of 256.

Required: No

WirelessGatewaysToRemove

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

Type: Array of strings

Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: