Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetNetworkProfile

Returns information about a network profile.

Request Syntax


{
   "arn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

The ARN of the network profile to return information about.

Type: String

Length Constraints: Minimum length of 32. Maximum length of 1011.

Pattern: ^arn:.+

Required: Yes

Response Syntax


{
   "networkProfile": { 
      "arn": "string",
      "description": "string",
      "downlinkBandwidthBits": number,
      "downlinkDelayMs": number,
      "downlinkJitterMs": number,
      "downlinkLossPercent": number,
      "name": "string",
      "type": "string",
      "uplinkBandwidthBits": number,
      "uplinkDelayMs": number,
      "uplinkJitterMs": number,
      "uplinkLossPercent": number
   }
}

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.

networkProfile

The network profile.

Type: NetworkProfile object

Errors

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

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400