Menu
AWS Device Farm
API Reference (API Version 2015-06-23)

CreateNetworkProfile

Creates a network profile.

Request Syntax

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

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.

description

The description of the network profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: No

downlinkBandwidthBits

The data throughput rate in bits per second, as an integer from 0 to 104857600.

Type: Long

Required: No

downlinkDelayMs

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

Type: Long

Required: No

downlinkJitterMs

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

Type: Long

Required: No

downlinkLossPercent

Proportion of received packets that fail to arrive from 0 to 100 percent.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

name

The name you wish to specify for the new network profile.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

projectArn

The Amazon Resource Name (ARN) of the project for which you want to create a network profile.

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

type

The type of network profile you wish to create. Valid values are listed below.

Type: String

Valid Values: CURATED | PRIVATE

Required: No

uplinkBandwidthBits

The data throughput rate in bits per second, as an integer from 0 to 104857600.

Type: Long

Required: No

uplinkDelayMs

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

Type: Long

Required: No

uplinkJitterMs

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

Type: Long

Required: No

uplinkLossPercent

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

Response Syntax

Copy
{ "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 that is returned by the create network profile request.

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

See Also

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