GetNetworkAnalyzerConfiguration - AWS IoT Wireless

GetNetworkAnalyzerConfiguration

Get network analyzer configuration.

Request Syntax

GET /network-analyzer-configurations/ConfigurationName HTTP/1.1

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 does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "Description": "string", "MulticastGroups": [ "string" ], "Name": "string", "TraceContent": { "LogLevel": "string", "MulticastFrameInfo": "string", "WirelessDeviceFrameInfo": "string" }, "WirelessDevices": [ "string" ], "WirelessGateways": [ "string" ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name of the new resource.

Type: String

Length Constraints: Maximum length of 1124.

Description

The description of the new resource.

Type: String

Length Constraints: Maximum length of 2048.

MulticastGroups

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

Type: Array of strings

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

Length Constraints: Maximum length of 256.

Name

Name of the network analyzer configuration.

Type: String

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

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

TraceContent

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

Type: TraceContent object

WirelessDevices

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

Type: Array of strings

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

Length Constraints: Maximum length of 256.

WirelessGateways

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

Type: Array of strings

Length Constraints: Maximum length of 256.

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: