DeviceFarm / Client / list_network_profiles

list_network_profiles#

DeviceFarm.Client.list_network_profiles(**kwargs)#

Returns the list of available network profiles.

See also: AWS API Documentation

Request Syntax

response = client.list_network_profiles(
    arn='string',
    type='CURATED'|'PRIVATE',
    nextToken='string'
)
Parameters:
  • arn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the project for which you want to list network profiles.

  • type (string) – The type of network profile to return information about. Valid values are listed here.

  • nextToken (string) – An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Return type:

dict

Returns:

Response Syntax

{
    'networkProfiles': [
        {
            '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
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • networkProfiles (list) –

      A list of the available network profiles.

      • (dict) –

        An array of settings that describes characteristics of a 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.

    • nextToken (string) –

      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Exceptions

  • DeviceFarm.Client.exceptions.ArgumentException

  • DeviceFarm.Client.exceptions.NotFoundException

  • DeviceFarm.Client.exceptions.LimitExceededException

  • DeviceFarm.Client.exceptions.ServiceAccountException