network_profiles

Creates, updates, deletes, gets or lists a network_profiles resource.

Overview

Name	network_profiles
Type	Resource
Id	aws.devicefarm.network_profiles

Fields

The following fields are returned by SELECT queries:

get_network_profile

Name	Datatype	Description
name	string	The name of the network profile.
arn	string	The Amazon Resource Name (ARN) of the network profile. (pattern: <code>^arn:aws:devicefarm:.+</code>)
description	string	The description of the network profile.
downlink_bandwidth_bits	integer (int64)	The data throughput rate in bits per second, as an integer from 0 to 104857600.
downlink_delay_ms	integer (int64)	Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
downlink_jitter_ms	integer (int64)	Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
downlink_loss_percent	integer	Proportion of received packets that fail to arrive from 0 to 100 percent.
type_	string	The type of network profile. Valid values are listed here. (CURATED, PRIVATE)
uplink_bandwidth_bits	integer (int64)	The data throughput rate in bits per second, as an integer from 0 to 104857600.
uplink_delay_ms	integer (int64)	Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
uplink_jitter_ms	integer (int64)	Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
uplink_loss_percent	integer	Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_network_profile	select	region		Returns information about a network profile.
create_network_profile	insert	region, projectArn, name		Creates a network profile.
update_network_profile	update	region, arn		Updates the network profile.
delete_network_profile	delete	region		Deletes a network profile.
list_network_profiles	exec	region, arn		Returns the list of available network profiles.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_network_profile

Returns information about a network profile.

SELECT
name,
arn,
description,
downlink_bandwidth_bits,
downlink_delay_ms,
downlink_jitter_ms,
downlink_loss_percent,
type_,
uplink_bandwidth_bits,
uplink_delay_ms,
uplink_jitter_ms,
uplink_loss_percent
FROM aws.devicefarm.network_profiles
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_network_profile

Creates a network profile.

INSERT INTO aws.devicefarm.network_profiles (
projectArn,
name,
description,
type,
uplinkBandwidthBits,
downlinkBandwidthBits,
uplinkDelayMs,
downlinkDelayMs,
uplinkJitterMs,
downlinkJitterMs,
uplinkLossPercent,
downlinkLossPercent,
region
)
SELECT 
'{{ projectArn }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ type }}',
{{ uplinkBandwidthBits }},
{{ downlinkBandwidthBits }},
{{ uplinkDelayMs }},
{{ downlinkDelayMs }},
{{ uplinkJitterMs }},
{{ downlinkJitterMs }},
{{ uplinkLossPercent }},
{{ downlinkLossPercent }},
'{{ region }}'
RETURNING
network_profile
;

Manifest

# Description fields are for documentation purposes
- name: network_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the network_profiles resource.
  - name: projectArn
    value: "{{ projectArn }}"
    description: |
      The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
  - name: name
    value: "{{ name }}"
    description: |
      The name for the new network profile.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the network profile.
  - name: type
    value: "{{ type }}"
    description: |
      The type of network profile to create. Valid values are listed here.
    valid_values: ['CURATED', 'PRIVATE']
  - name: uplinkBandwidthBits
    value: {{ uplinkBandwidthBits }}
    description: |
      The data throughput rate in bits per second, as an integer from 0 to 104857600.
  - name: downlinkBandwidthBits
    value: {{ downlinkBandwidthBits }}
    description: |
      The data throughput rate in bits per second, as an integer from 0 to 104857600.
  - name: uplinkDelayMs
    value: {{ uplinkDelayMs }}
    description: |
      Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
  - name: downlinkDelayMs
    value: {{ downlinkDelayMs }}
    description: |
      Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
  - name: uplinkJitterMs
    value: {{ uplinkJitterMs }}
    description: |
      Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
  - name: downlinkJitterMs
    value: {{ downlinkJitterMs }}
    description: |
      Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
  - name: uplinkLossPercent
    value: {{ uplinkLossPercent }}
    description: |
      Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
  - name: downlinkLossPercent
    value: {{ downlinkLossPercent }}
    description: |
      Proportion of received packets that fail to arrive from 0 to 100 percent.

UPDATE examples

update_network_profile

Updates the network profile.

UPDATE aws.devicefarm.network_profiles
SET 
arn = '{{ arn }}',
name = '{{ name }}',
description = '{{ description }}',
type = '{{ type }}',
uplinkBandwidthBits = {{ uplinkBandwidthBits }},
downlinkBandwidthBits = {{ downlinkBandwidthBits }},
uplinkDelayMs = {{ uplinkDelayMs }},
downlinkDelayMs = {{ downlinkDelayMs }},
uplinkJitterMs = {{ uplinkJitterMs }},
downlinkJitterMs = {{ downlinkJitterMs }},
uplinkLossPercent = {{ uplinkLossPercent }},
downlinkLossPercent = {{ downlinkLossPercent }}
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
network_profile;

DELETE examples

delete_network_profile

Deletes a network profile.

DELETE FROM aws.devicefarm.network_profiles
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_network_profiles

Returns the list of available network profiles.

EXEC aws.devicefarm.network_profiles.list_network_profiles 
@region='{{ region }}' --required 
@@json=
'{
"arn": "{{ arn }}", 
"type": "{{ type }}", 
"nextToken": "{{ nextToken }}"
}'
;