DeviceFarm / Paginator / ListNetworkProfiles

ListNetworkProfiles#

class DeviceFarm.Paginator.ListNetworkProfiles#
paginator = client.get_paginator('list_network_profiles')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DeviceFarm.Client.list_network_profiles().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    arn='string',
    type='CURATED'|'PRIVATE',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': '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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

      A token to resume pagination.