DeviceFarm / Client / get_network_profile

get_network_profile#

DeviceFarm.Client.get_network_profile(**kwargs)#

Returns information about a network profile.

See also: AWS API Documentation

Request Syntax

response = client.get_network_profile(
    arn='string'
)
Parameters:

arn (string) –

[REQUIRED]

The ARN of the network profile to return information about.

Return type:

dict

Returns:

Response Syntax

{
    'networkProfile': {
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'type': 'CURATED'|'PRIVATE',
        'uplinkBandwidthBits': 123,
        'downlinkBandwidthBits': 123,
        'uplinkDelayMs': 123,
        'downlinkDelayMs': 123,
        'uplinkJitterMs': 123,
        'downlinkJitterMs': 123,
        'uplinkLossPercent': 123,
        'downlinkLossPercent': 123
    }
}

Response Structure

  • (dict) –

    • networkProfile (dict) –

      The network profile.

      • arn (string) –

        The Amazon Resource Name (ARN) of the network profile.

      • name (string) –

        The name of the network profile.

      • description (string) –

        The description of the network profile.

      • type (string) –

        The type of network profile. Valid values are listed here.

      • uplinkBandwidthBits (integer) –

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

      • downlinkBandwidthBits (integer) –

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

      • uplinkDelayMs (integer) –

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

      • downlinkDelayMs (integer) –

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

      • uplinkJitterMs (integer) –

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

      • downlinkJitterMs (integer) –

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

      • uplinkLossPercent (integer) –

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

      • downlinkLossPercent (integer) –

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

Exceptions