libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DeviceFarm.Types.DeviceFilter

Description

 
Synopsis

Documentation

data DeviceFilter Source #

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

See: newDeviceFilter smart constructor.

Constructors

DeviceFilter' 

Fields

  • attribute :: DeviceFilterAttribute

    The aspect of a device such as platform or model used as the selection criteria in a device filter.

    The supported operators for each attribute are provided in the following list.

    ARN
    The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

    Supported operators: EQUALS, IN, NOT_IN

    PLATFORM
    The device platform. Valid values are ANDROID or IOS.

    Supported operators: EQUALS

    OS_VERSION
    The operating system version (for example, 10.3.2).

    Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

    MODEL
    The device model (for example, iPad 5th Gen).

    Supported operators: CONTAINS, EQUALS, IN, NOT_IN

    AVAILABILITY
    The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

    Supported operators: EQUALS

    FORM_FACTOR
    The device form factor. Valid values are PHONE or TABLET.

    Supported operators: EQUALS

    MANUFACTURER
    The device manufacturer (for example, Apple).

    Supported operators: EQUALS, IN, NOT_IN

    REMOTE_ACCESS_ENABLED
    Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

    Supported operators: EQUALS

    REMOTE_DEBUG_ENABLED
    Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

    Supported operators: EQUALS

    Because remote debugging is no longer supported, this filter is ignored.

    INSTANCE_ARN
    The Amazon Resource Name (ARN) of the device instance.

    Supported operators: EQUALS, IN, NOT_IN

    INSTANCE_LABELS
    The label of the device instance.

    Supported operators: CONTAINS

    FLEET_TYPE
    The fleet type. Valid values are PUBLIC or PRIVATE.

    Supported operators: EQUALS

  • operator :: RuleOperator

    Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

  • values :: [Text]

    An array of one or more filter values used in a device filter.

    Operator Values

    • The IN and NOT_IN operators can take a values array that has more than one element.
    • The other operators require an array with a single element.

    Attribute Values

    • The PLATFORM attribute can be set to ANDROID or IOS.
    • The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    • The FORM_FACTOR attribute can be set to PHONE or TABLET.
    • The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.

Instances

Instances details
Eq DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

(==) :: DeviceFilter -> DeviceFilter -> Bool #

(/=) :: DeviceFilter -> DeviceFilter -> Bool #

Read DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

readsPrec :: Int -> ReadS DeviceFilter #

readList :: ReadS [DeviceFilter] #

readPrec :: ReadPrec DeviceFilter #

readListPrec :: ReadPrec [DeviceFilter] #

Show DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

showsPrec :: Int -> DeviceFilter -> ShowS #

show :: DeviceFilter -> String #

showList :: [DeviceFilter] -> ShowS #

Generic DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Associated Types

type Rep DeviceFilter :: Type -> Type #

Methods

from :: DeviceFilter -> Rep DeviceFilter x #

to :: Rep DeviceFilter x -> DeviceFilter #

NFData DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

rnf :: DeviceFilter -> () #

Hashable DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

hashWithSalt :: Int -> DeviceFilter -> Int #

hash :: DeviceFilter -> Int #

ToJSON DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

toJSON :: DeviceFilter -> Value #

toEncoding :: DeviceFilter -> Encoding #

toJSONList :: [DeviceFilter] -> Value #

toEncodingList :: [DeviceFilter] -> Encoding #

FromJSON DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

Methods

parseJSON :: Value -> Parser DeviceFilter #

parseJSONList :: Value -> Parser [DeviceFilter] #

type Rep DeviceFilter Source # 
Instance details

Defined in Amazonka.DeviceFarm.Types.DeviceFilter

type Rep DeviceFilter = D1 ('MetaData "DeviceFilter" "Amazonka.DeviceFarm.Types.DeviceFilter" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "DeviceFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceFilterAttribute) :*: (S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RuleOperator) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newDeviceFilter Source #

Arguments

:: DeviceFilterAttribute

$sel:attribute:DeviceFilter'

-> RuleOperator

$sel:operator:DeviceFilter'

-> DeviceFilter 

Create a value of DeviceFilter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attribute:DeviceFilter', deviceFilter_attribute - The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN
The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

Supported operators: EQUALS, IN, NOT_IN

PLATFORM
The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS

OS_VERSION
The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL
The device model (for example, iPad 5th Gen).

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FORM_FACTOR
The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS

MANUFACTURER
The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS
The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE
The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

$sel:operator:DeviceFilter', deviceFilter_operator - Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

$sel:values:DeviceFilter', deviceFilter_values - An array of one or more filter values used in a device filter.

Operator Values

  • The IN and NOT_IN operators can take a values array that has more than one element.
  • The other operators require an array with a single element.

Attribute Values

  • The PLATFORM attribute can be set to ANDROID or IOS.
  • The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
  • The FORM_FACTOR attribute can be set to PHONE or TABLET.
  • The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.

deviceFilter_attribute :: Lens' DeviceFilter DeviceFilterAttribute Source #

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN
The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

Supported operators: EQUALS, IN, NOT_IN

PLATFORM
The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS

OS_VERSION
The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL
The device model (for example, iPad 5th Gen).

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY
The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALS

FORM_FACTOR
The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS

MANUFACTURER
The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED
Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED
Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.

INSTANCE_ARN
The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS
The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE
The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALS

deviceFilter_operator :: Lens' DeviceFilter RuleOperator Source #

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

deviceFilter_values :: Lens' DeviceFilter [Text] Source #

An array of one or more filter values used in a device filter.

Operator Values

  • The IN and NOT_IN operators can take a values array that has more than one element.
  • The other operators require an array with a single element.

Attribute Values

  • The PLATFORM attribute can be set to ANDROID or IOS.
  • The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
  • The FORM_FACTOR attribute can be set to PHONE or TABLET.
  • The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.